Developer Documentation

REST API Operations Index

All available NSX VMC Policy REST API Operations.


AAA

Effective Permissions
get Get Path Permissions
Get effective object permissions to object specified by path for current user.
Object Permissions
patch Create Update Object Permissions
Create/update object permission mappings
delete Delete Object Permissions
Delete object-permissions entries
get Get Object Permissions
Get list of Object-level RBAC entries.

Compliance

Status
get Get Policy Compliance Status
Returns the compliance status

Domains

Communication Maps
delete Delete Communication Entry
Delete CommunicationEntry
delete Delete Communication Map For Domain
Deletes a communication map from this domain
get Get Communication Entry
Read CommunicationEntry
get Get Communication Map For Domain
Read communication-map
get List Communication Entries
List CommunicationEntries
get List Communication Maps For Domain
List communication maps
patch Patch Communication Entry
Patch a CommunicationEntry
patch Patch Communication Map For Domain
Patch communication map
post Revise Communication Entry
Revise the positioning of communication entry
post Set Communication Map Precedence
Revise the positioning of communication maps
put Update Communication Entry
Create or update a CommunicationEntry
put Update Communication Map For Domain
Create or Update communication map
Deployment Maps
put Create Or Update Deployment Map
Create a new Domain Deployment Map under infra
Endpoint Policies
put Create Or Update Endpoint Policy
Create or update Endpoint policy
put Create Or Update Endpoint Rule
Update Endpoint rule
delete Delete Endpoint Policy
Delete Endpoint policy
delete Delete Endpoint Rule
Delete EndpointRule
get Get Endpoint Policy
Read Endpoint policy
get Get Endpoint Rule
Read Endpoint rule
get List Endpoint Policies Across Domains
List Endpoint policies
get List Endpoint Rules
List Endpoint rules
patch Patch Endpoint Policy
Create or update Endpoint policy
patch Patch Endpoint Rule
Update Endpoint rule
Firewall Flood Protection Profile Binding Maps
get List Firewall Flood Protection Bindings Across Domains
List Firewall Flood Protection Profile Binding Maps for all domains
Firewall Session Timer Profile Binding Maps
get List Firewall Session Timer Bindings Across Domains
List Firewall Session Timer Profile Binding Maps for all domains
Forwarding Policies
put Create Or Update Forwarding Policy
Create or update forwarding policy
patch Create Or Update Forwarding Policy
Create or update forwarding policy
put Create Or Update Forwarding Rule
Update forwarding rule
patch Create Or Update Forwarding Rule
Update forwarding rule
delete Delete Forwarding Policy
Delete forwarding policy
delete Delete Forwarding Rule
Delete ForwardingRule
get Get Forwarding Policy
Read forwarding policy
get Get Forwarding Rule
Read rule
get List Forwarding Policies
List forwarding policies for the given domain
get List Forwarding Rules
List rules
Gateway Policies
put Create Or Replace Gateway Policy For Domain
Update gateway policy
put Create Or Replace Gateway Policy Rule
Update gateway rule
delete Delete Gateway Policy
Delete GatewayPolicy
delete Delete Gateway Policy Rule
Delete rule
get Get Gateway Policies
Read gateway policy
get Get Gateway Policy Rule
Read rule
get Get Gateway Policy Rule Statistics
Get gateway rule statistics
get Get Gateway Policy Stats
Get gateway policy statistics
get List Gateway Policies
List gateway policies
get List Gateway Policy Rules
List rules
post Revise Gateway Policy
Revise the positioning of gateway policy
post Revise Gateway Policy Rule
Revise the positioning of gateway rule
patch Update Gateway Policy For Domain
Update gateway policy
patch Update Gateway Policy Rule
Update gateway rule
Groups
put Create Firewall Session Timer Profile Binding
Update Firewall Session Timer Profile Binding Map
put Create Group DNS Security Profile Binding
Update DNS security profile binding map
put Create Group Firewall Flood Protection Profile Binding
Update Firewall Flood Protection Profile Binding Map
put Create Group Monitoring Profile Binding
Update Group Monitoring Profile Binding Map
put Create Group Port Mirroring Instance
Create or Replace Port Mirroring Instance.
put Create Or Update Group
Create or update a group
delete Delete Group
Delete Group
delete Delete Group DNS Security Binding
Delete DNS security profile binding map
delete Delete Group Firewall Flood Protection Profile Binding
Delete Firewall Flood Protection Profile Binding
delete Delete Group Firewall Session Timer Profile Binding
Delete Firewall Session Timer Profile Binding
delete Delete Group Monitoring Profile Binding
Delete Group Monitoring Profile Binding
delete Delete Group Port Mirroring Instance
Delete Port Mirroring Instance
get Get Group
Read group
get Get Group DNS Security Profile Binding
Get DNS security profile binding map
get Get Group Firewall Flood Protection Binding
Get Firewall Flood Protection Profile Binding Map
get Get Group Firewall Session Timer Binding
Get Firewall Session Timer Profile Binding Map
get Get Group IP Members
Get IP addresses that belong to this Group
get Get Group Logical Port Members
Get logical ports that belong to this Group
get Get Group Logical Switch Members
Get logical switches that belong to this Group
get Get Group Monitoring Profile Binding
Get Group Monitoring Profile Binding Map
get Get Group Port Mirroring Instance
Details of Port Mirroring Instance
get Get Group Segment Members
Get segments that belong to this Group
get Get Group Segment Port Members
Get segment ports that belong to this Group
get Get Group Tags
Get tags used to define conditions inside a Group
get Get Group VM Members
Get Virtual machines that belong to this Group
get Get Group VM Stats
Get effective VMs for the Group
get List Group DNS Security Profile Bindings
Get DNS security profile binding map
get List Group Firewall Flood Protection Profile Bindings
List Firewall Flood Protection Profile Binding Maps
get List Group Firewall Session Timer Profile Binding
List Firewall Session Timer Profile Binding Maps
get List Group Monitoring Profile Bindings
List Group Monitoring Profile Binding Maps
get List Group Port Mirroring Instances
List Port Mirroring Instances
get List Groups
List Groups for a domain
patch Update Group
Patch a group
patch Update Group DNS Security Profile Binding
Create or update DNS security profile binding map
patch Update Group Firewall Flood Protection Profile Binding
Create or update Firewall Flood Protection Profile Binding Map
patch Update Group Firewall Session Timer Policy
Create or update Firewall Session Timer Profile Binding Map
patch Update Group Monitoring Profile Binding
Create Group Monitoring Profile Binding Map
patch Update Group Port Mirroring Instance
Patch Port Mirroring Instance.
Properties
patch Create Or Update Domain For Infra
Patch a domain
delete Delete Domain
Delete Domain and all the entities contained by this domain
get Get Domain For Infra
Read domain
get List Domain For Infra
List domains for infra
put Update Domain For Infra
Create or update a domain
Redirection Policies
put Create Redirection Policy
Create or update redirection policy
put Create Redirection Policy Rule
Update redirection rule
delete Delete Redirection Policy
Delete redirection policy
delete Delete Redirection Policy Rule
Delete RedirectionRule
get Get Redirection Policy
Read redirection policy
get Get Redirection Policy Rule
Read rule
get List Redirection Policies
List redirection policys for a domain
get List Redirection Policies Across Domains
List redirection policys
get List Redirection Policy Rules
List rules
patch Update Redirection Policy
Create or update redirection policy
patch Update Redirection Policy Rule
Update redirection rule
Security Policies
put Create Security Policy
Create or Update security policy
put Create Security Policy Rule
Create or update a rule
delete Delete Security Policy
Deletes a security policy from this domain
delete Delete Security Policy Rule
Delete rule
get Get Security Policy
Read security policy
get Get Security Policy Rule
Read rule
get Get Security Policy Rule Stats
Get rule statistics
get Get Security Policy Stats
Get security policy statistics
get List Security Policies
List security policies
get List Security Policy Rules
List rules
post Revise Security Policy
Revise the positioning of security policies
post Revise Security Policy Rule
Revise the positioning of rule
patch Update Security Policy
Patch security policy
patch Update Security Policy Rule
Patch a rule

Enforcement Points

Service Definitions
post Create Service Definition
Create a Service Definition on given enforcement point.
delete Delete Service Definition
Delete an existing Service Definition on the given enforcement point
get Get Service Definition
Read Service Definition with given service-definition-id.
get List Service Definitions
List all Service Definitions registered on given enforcement point.
put Update Service Definition
Update an existing Service Definition on the given enforcement point

Fine Tuning

Resources
get List Resource Info
For each type of entity what are the attributes owned by policy.

Infrastructure

CRLs
patch Create Patch TLS CRL
Create or patch a Certificate Revocation List
put Create Update TLS CRL
Create or fully replace a Certificate Revocation List
delete Delete TLS CRL
Delete a CRL
get Get TLS CRL
Show CRL Data for the Given CRL id.
get List TLS CRLs
Return All Added CRLs
CRLs Import
post Create TLS CRL Import
Create a new Certificate Revocation List
Certificates
put Add TLS Certificate
Add a New Certificate
delete Delete TLS Certificate
Delete Certificate for the Given Certificate ID
get Get TLS Certificate
Show Certificate Data for the Given Certificate ID
get List TLS Certificates
Return All the User-Facing Components' Certificates
patch Update TLS Certificate
Add a New Certificate
Context Profiles
put Create Update Policy Context Profile
Create PolicyContextProfile
patch Create Update Policy Context Profiles
Create PolicyContextProfile
delete Delete Policy Context Profile
Delete Policy Context Profile
get Get Policy Context Profile
Get PolicyContextProfile
get List Policy Context Profiles
Get PolicyContextProfiles
Context Profiles Attributes
get List Profile Supported Attributes
List Policy Context Profile supported attributes and sub-attributes
DHCP Relay Configs
put Create Or Replace DHCP Relay Config
Create or update DHCP relay configuration
delete Delete DHCP Relay Config
Delete DHCP relay configuration
get List DHCP Relay Config
List DHCP relay config instances
patch Patch DHCP Relay Config
Create or update DHCP relay configuration
get Read DHCP Relay Config
Read DHCP relay configuration
DHCP Server Configs
put Create Or Replace DHCP Server Config
Create or update DHCP server configuration
delete Delete DHCP Server Config
Delete DHCP server configuration
get List DHCP Server Config
List DHCP server config instances
patch Patch DHCP Server Config
Create or update DHCP server configuration
get Read DHCP Server Config
Read DHCP server configuration
DNS Forwarder Zones
patch Create Or Update DNS Forwarder Zone
Create or update the DNS Forwarder Zone
delete Delete Polcity DNS Forwarder Zone
Delete the DNS Forwarder Zone
get List Policy DNS Forwarder Zone
List Dns Forwarder Zones
get Read Policy DNS Forwarder Zone
Read the DNS Forwarder Zone
put Update Policy DNS Forwarder Zone
Create or update the DNS Forwarder Zone
DNS Security Profiles
patch Create Or Update DNS Security Profile
Create or update DNS security profile
delete Delete DNS Security Profile
Delete DNS security profile
get Get DNS Security Profile
Read the DNS Forwarder for the given tier-0 instance
get List DNS Security Profiles
List all DNS security profiles
put Update DNS Security Profile
Create or update DNS security profile
Drafts
post Abort Policy Draft
Aborts publishing of a draft if there is a failure
put Create Policy Draft
Create or update a manual draft
delete Delete Policy Draft
Delete a manual draft
get Get Aggregated Policy Draft
Get an aggregated configuration for the draft
get Get Policy Draft
Read draft
get Get Policy Draft Preview
Get a preview of a configuration after publish of a draft
get List Policy Drafts
List policy drafts
post Publish Policy Draft
Publish a draft
patch Update Policy Draft
Patch a manual draft
Firewall Session Timer Profiles
put Create Firewall Session Timer Profile
Update Firewall Session Timer Profile
delete Delete Firewall Timer Profile
Delete Firewall Session Timer Profile
get Get Firewall Session Timer Profile
Get Firewall Session Timer Profile
get List Firewall Session Timer Profiles
List Firewall Session Timer Profiles
patch Update Firewall Session Timer Profile
Create or update Firewall Session Timer Profile
Flood Protection Profiles
put Create Flood Protection Profile
Update Firewall Flood Protection Profile
delete Delete Flood Protection Profile
Delete Flood Protection Profile
get Get Flood Protection Profile
Get Flood Protection Profile
get List Flood Protection Profile Bindings
List Flood Protection Profiles
get List Flood Protection Profiles
List Flood Protection Profiles
patch Update Flood Protection Profile
Create or update Flood Protection Profile
Global Configuration
put Create Global Configuration
Update the global configuration
get Get Global Configuration
Read global configuration
patch Update Global Configuration
Update the global configuration
Group Associations
get Get Policy Groups
Get groups for which the given object is a member
IP Blocks
put Create IP Address Block
Create or Replace IpAddressBlock
delete Delete IP Address Block
Delete an IpAddressBlock
get Get IP Address Block
Read a IpAddressBlock
get List IP Address Blocks
List IpAddressBlocks
patch Update IP Address Block
Create a new IPBlock
IP Discovery Profiles
put Create IP Discovery Profile
Update IP Discovery Profile
delete Delete IP Discovery Profile
Delete IP Discovery Profile
get Get IP Discovery Profile
Get IP Discovery Profile
get List IP Discovery Profiles
List IP Discovery Profiles
patch Update IP Discovery Profile
Create IP Discovery Profile
IP Pools
put Create IP Address Pool
Create or Replace IpAddressPool
put Create IP Address Pool Allocation
Records intent to allocate an IP Address from an IP Pool
put Create IP Address Pool Subnet
Create a new IP Subnet
delete Delete IP Address Pool
Delete an IpAddressPool
delete Delete IP Address Pool Allocation
Records intent to release an IP from an IpPool.
delete Delete IP Address Pool Subnet
Delete an IpAddressPoolSubnet
get Get IP Address Pool
Read an IpAddressPool
get Get IP Address Pool Allocation
Read policy IpPool allocation
get Get IP Address Pool Subnet
Read an IpAddressPoolSubnet
get List IP Address Pool Allocations
List IpAddressPool Allocations
get List IP Address Pool Subnbets
List IpAddressPoolSubnets
get List IP Address Pools
List IpAddressPools
patch Update IP Address Pool
Create a new IP address pool
patch Update IP Address Pool Allocation
Records intent to allocate an IP Address from an IP Pool
patch Update IP Address Pool Subnet
Create a new IP Subnet
IPFIX Collector Profiles
put Create IPFIX Collector Profile
Create or Replace IPFIX collector profile
delete Delete IPFIX Collector Profile
Delete IPFIX Collector profile
get Get IPFIX Collector Profile
Get IPFIX Collector profile
get List IPFIX Collector Profiles
List IPFIX Collector profiles.
patch Update IPFIX Collector Profile
Patch IPFIX collector profile
IPFIX DFW Collector Profiles
put Create IPFIX DFW Collector Profile
Create or Replace IPFIX dfw collector profile
delete Delete IPFIX DFW Collector Profile
Delete IPFIX dfw Collector profile
get Get IPFIX DFW Collector Profile
Get IPFIX dfw Collector profile
get List IPFIX DFW Collector Profiles
List IPFIX Collector profiles.
patch Update IPFIX DFW Collector Profile
IPFIX dfw collector profile id
IPFIX DFW Profiles
put Create IPFIX DFW Profile
Create or Replace IPFIX DFW collection Config.
delete Delete IPFIX DFW Profile
Delete IPFIX DFW Profile
get Get IPFIX DFW Profile
Get IPFIX DFW Profile
get List IPFIX DFW Profile
List IPFIX DFW Profile
patch Update IPFIX DFW Profile
Patch IPFIX DFW profile
IPFIX L2 Collector Profiles
put Create IPFIX L2 Collector Profile
Create or Replace IPFIX collector profile
delete Delete IPFIX L2 Collector Profile
Delete IPFIX Collector profile
get Get IPFIX L2 Collector Profile
Get IPFIX Collector profile
get List IPFIX L2 Collector Profiles
List IPFIX Collector profiles.
patch Update IPFIX L2 Collector Profile
Patch IPFIX collector profile
IPFIX L2 Profiles
put Create IPFIX L2 Profile
Create or Replace IPFIX L2 profile
delete Delete IPFIX L2 Profile
Delete IPFIX L2 Profile
get Get IPFIX L2 Collector Profile
Get IPFIX L2 Profile
get List IPFIX L2 Profile
List IPFIX L2 Profiles
patch Update IPFIX L2 Profile
Patch IPFIX L2profile
IPsec VPN DPD Profiles
put Create IPsec VPN DPD Profile
Create or fully replace a custom IPSec tunnel Profile
delete Delete IPsec VPN DPD Profile
Delete custom dead peer detection (DPD) profile
get Get IPsec VPN DPD Profile
Get dead peer detection (DPD) profile
get List IPsec VPN DPD Profiles
List DPD profiles
patch Update IPsec VPN DPD Profile
Create or patch a custom DPD Profile
IPsec VPN IKE Profiles
put Create IPsec VPN IKE Profile
Create or fully replace a custom internet key exchange (IKE) Profile
delete Delete IPsec VPN IKE Profile
Delete custom IKE Profile
get Get IPsec VPN IKE Profile
Get IKE Profile
get List IPsec VPN IKE Profile
List IKE profiles
patch Update IPsec VPN IKE Profile
Create or patch a custom internet key exchange (IKE) Profile
IPsec VPN Tunnel Profiles
put Create IPsec VPN Tunnel Profile
Create or fully replace a custom IPSec tunnel Profile
delete Delete IPsec VPN Tunnel Profile
Delete custom IPSec tunnel Profile
get Get IPsec VPN Tunnel Profile
Get IPSec tunnel Profile
get List IPsec VPN Tunnel Profile
List IPSec tunnel profiles
patch Update IPsec VPN Tunnel Profile
Create or patch a custom IPSec tunnel Profile
IPv6 DAD Profiles
put Create IPv6 DAD Profile
Create or update IPv6 DAD profile
delete Delete IPv6 DAD Profile
Delete IPv6 DAD profile
get Get IPv6 DAD Profile
Read IPv6 DAD profile
get List IPv6 DAD Profiles
List all IPv6 DAD profiles
patch Update IPv6 DAD Profile
Create or update IPv6 DAD profile
IPv6 NDRA Profiles
put Create IPv6 NDRA Profile
Create or update IPv6 NDRA profile
delete Delete IPv6 NDRA Profile
Delete IPv6 NDRA profile
get Get IPv6 NDRA Profile
Read IPv6 NDRA profile
get List IPv6 NDRA Profiles
List all IPv6 NDRA profiles
patch Update IPv6 NDRA Profile
Create or update IPv6 NDRA profile
Mac Discovery Profiles
put Create Mac Discovery Profile
Update Mac Discovery Profile
delete Delete Mac Discovery Profile
Delete Mac Discovery Profile
get Get Mac Discovery Profile
Get Mac Discovery Profile
get List Mac Discovery Profiles
List Mac Discovery Profiles
patch Update Mac Discovery Profile
Create Mac Discovery Profile
Partner Services
get Get Partner Service
Read partner service identified by provided name
get List Partner Services
Read partner services
Port Mirroring Profiles
put Create Port Mirroring Profile
Create or Replace Port Mirroring Profile.
delete Delete Port Mirroring Profile
Delete Port Mirroring Profile
get Get Port Mirroring Profile
Details of Port Mirroring Profile
get List Port Mirroring Profiles
List Port Mirroring Profiles
patch Update Port Mirroring Profile
Patch Port Mirroring Profile.
Properties
get Read Infra
Read infra
patch Update Infra
Update the infra including all the nested entities
put Update Infra Nested
Update the infra including all the nested entities
QoS Profiles
put Create QoS Profile
Create or Replace QoS profile.
delete Delete QoS Profile
Delete QoS profile
get Get QoS Profile
Details of QoS profile
get List QoS Profiles
List QoS Profiles
patch Update QoS Profile
Patch QoS profile.
Segment Security Profiles
put Create Segment Security Profiles
PUT segment security profile id
delete Delete Segment Security Profile
DELETE segment security profile
get Get Segment Security Profile
GET Segment security profile id
get List Segment Security Profiles
List segment security profiles
patch Update Segment Security Profile
PATCH segment security profile id
Segments
put Create Port Discovery Bindings
Update Infra Port Discovery Profile Binding Map
put Create Port Monitoring Bindings
Update Infra Port Monitoring Profile Binding Map
put Create Port QoS Bindings
Update Port QoS Profile Binding Map
put Create Segment
Create or update a infra segment
put Create Segment Discovery Binding
Update Infra Segment Discovery Profile Binding Map
put Create Segment Monitoring Bindings
Update Infra Segment Monitoring Profile Binding Map
put Create Segment Port Security Profile Binding
Create or replace the infra segment port security profile binding map
put Create Segment Ports
Create or update an infra segment port
put Create Segment QoS Binding
Update Segment QoS Profile Binding Map
put Create Segment Security Profile Binding
Create or replace infra segment security profile binding map
put Create Service Segment
Create service segment
delete Delete Port Discovery Binding
Delete Infra Port Discovery Profile Binding Profile
delete Delete Port Monitoring Binding
Delete Infra Port Monitoring Profile Binding Profile
delete Delete Port QoS Binding
Delete Port QoS Profile Binding Profile
delete Delete Segment
Delete infra segment
delete Delete Segment Discovery Binding
Delete Segment Discovery Profile Binding Profile
delete Delete Segment Monitoring Binding
Delete Infra Segment Monitoring Profile Binding Profile
delete Delete Segment Port
Delete an infra segment port
delete Delete Segment Port Security Profile Binding
Delete the infra segment port security profile binding map
delete Delete Segment QoS Binding
Delete Segment QoS Profile Binding Profile
delete Delete Segment Security Profile Binding
Delete infra segment security profile binding map
delete Delete Service Segment
Delete Service Segment
delete Force Delete Segment
Force delete infra segment
get Get Port Discovery Binding
Get Infra Port Discovery Profile Binding Map
get Get Port Monitoring Binding
Get Infra Port Monitoring Profile Binding Map
get Get Port QoS Binding
Get Port QoS Profile Binding Map
get Get Segment
Read infra segment
get Get Segment Discovery Binding
Get Infra Segment Discovery Profile Binding Map
get Get Segment Monitoring Binding
Get Infra Segment Monitoring Profile Binding Map
get Get Segment Port
Get infra segment port by ID
get Get Segment Port Security Profile Binding
Get infra segment port security profile binding map
get Get Segment Port Statistics
Get infra segment port statistics information
get Get Segment QoS Binding
Get Segment QoS Profile Binding Map
get Get Segment Security Profile Binding
Get infra segment security profile binding map
get Get Segment Stats
Get infra segment statistics information
get Get Service Segment
Read Service Segment
get List All Segments
List all segments under infra
get List Port Discovery Bindings
List Infra Port Discovery Profile Binding Maps
get List Port Monitoring Bindings
List Infra Port Monitoring Profile Binding Maps
get List Port QoS Bindings
List Port QoS Profile Binding Maps
get List Segment Discovery Bindings
List Infra Segment Discovery Profile Binding Maps
get List Segment Monitoring Bindings
List Infra Segment Monitoring Profile Binding Maps
get List Segment Port Security Profile Bindings
List infra segment port security profile binding maps
get List Segment Ports
List infra segment ports
get List Segment QoS Bindings
List Segment QoS Profile Binding Maps
get List Segment Security Profile Bindings
List infra segment security profile binding maps
get List Service Segments
List Service Segments
patch Update Port Discovery Bindings
Create Infra Port Discovery Profile Binding Map
patch Update Port Monitoring Bindings
Create Infra Port Monitoring Profile Binding Map
patch Update Port QoS Bindings
Create Port QoS Profile Binding Map
patch Update Segment
Create or update a segment
patch Update Segment Discovery Binding
Create Infra Segment Discovery Profile Binding Map
patch Update Segment Monitoring Binding
Create Infra Segment Monitoring Profile Binding Map
patch Update Segment Port Security Profile Bindings
Patch infra segment port security profile binding map
patch Update Segment Ports
Patch an infra segment port
patch Update Segment QoS Binding
Create Segment QoS Profile Binding Map
patch Update Segment Security Profile Binding
Patch infra segment security profile binding map
patch Update Service Segment
Create a service segment
Service Profiles
get Get Service Profile Groups
Get Groups used in Redirection rules for a given Service Profile.
get List Service Chain Mapppings
List all service chain mappings for given service profile.
Services
put Create Service Entry
Create or update a ServiceEntry
put Create Service For Tenant
Create or update a Service
delete Delete Service Entry
Delete Service entry
delete Delete Service For Tenant
Delete Service
get Get Service Entry
Service entry
get Get Service For Tenant
Read a service
get List Service Entries
List Service entries for the given service
get List Services For Tenant
List Services for infra
patch Update Service Entry
Patch a ServiceEntry
patch Update Service For Tenant
Patch a Service
Session Timer Profiles
get List Session Timer Profile Bindings
List Session Timer Profiles
Sites
delete Delete Enforcement Point
Delete EnforcementPoint from Site
post Full Sync Enforcement Point
Full sync EnforcementPoint from Site
get Get Edge Cluster For Enforcement Point
Read a Edge Cluster under an Enforcement Point
get Get Edge Node For Enforcement Point
Read a Edge Node under an Enforcement Point, Edge Cluster
get Get Enforcement Point
Read an Enforcement Point under Infra/Site
get Get Site
Read a site
get Get Transport Zone For Enforcement Point
Read a Transport Zone under an Enforcement Point
get List Edge Clusters For Enforcement Point
List Edge Clusters under an Enforcement Point
get List Edge Nodes For Enforcement Point
List Edge Nodes under an Enforcement Point, Edge Cluster
get List Site Enforcement Points
List enforcementpoints under Site
get List Sites
List sites for infra
get List Transport Zones For Enforcement Point
List Transport Zones under an Enforcement Point
post Reload Enforcement Point
Reload an Enforcement Point under Site
patch Update Enforcement Point
Patch a new Enforcement Point under Site
Spoofguard Profiles
delete Delete Spoofguard Profile
Delete SpoofGuard profile
get Get Spoofguard Profile
Get SpoofGuard profile
patch Get Spoofguard Profile
Patch SpoofGuard profile
get List Spoofguard Profiles
List SpoofGuard profiles
put Update Spoofguard Profile
Create or replace SpoofGuard profile

Realized State

Alarms
get List Alarms
List All alarms in the system
Enforcement Points
post Apply Tags To Enforcement Point VM
Apply tags on virtual machine
get List VIFs On Enforcement Point
Listing of VIFs on the NSX Manager
get List Virtual Machines On Enforcement Point
Listing of Virtual machines on the NSX Manager
Realized Entities
get Get Realized Entity
Get realized entity uniquely identified by realized path
get List Realized Entities
Get list of realized objects associated with intent object
post Refresh Realized Entities
Refresh all realized entities associated with the intent-path
Status
get Get Intent Status
Get consolidated status of an intent object
Virtual Machines
get List All Virtual Machines
List all virtual machines

Settings

Firewall IDFW Cluster
put Create Compute Cluster IDFW Config
Create or update compute cluster idfw configuration
get Get Compute Cluster IDFW Config
Read compute cluster idfw configuration
get List Compute Cluster IDFW Config
List compute cluster idfw Configuration
patch Update Compute Cluster IDFW Config
Patch compute cluster idfw configuration
Firewall IDFW Standalone Host Switch Setting
put Create Standalone Host IDFW Config
Create or update idfw configuration for standalone host
get Get Standalone Host IDFW Config
Read idfw configuration for standalone host
patch Update Standalone Host IDFW Config
Patch idfw configuration for standalone host
Firewall Security
put Create DFW Firewall Config
Update dfw firewall configuration
get Get DFW Firewall Config
Get dfw firewall configuration
patch Update DFW Firewall Config
Update dfw firewall configuration
Firewall Security Exclude List
put Create Firewall Exclude List
Create or update exclusion list for security policy
get Get Firewall Exclude List
Read security policy exclude list
patch Update Firewall Exclude List
Patch exclusion list for security policy
Firewall Stats
post Reset Firewall Stats
Reset firewall rule statistics

Tier 0s

Community Lists
get Get Community List
Read a BGP community list
get List Community Lists
List BGP community lists
patch Update Community List
Create or update a BGP community list
DNS Forwarder
delete Delete DNS Forwarder Configuration
Delete DNS configuration for tier-0 instance
get Get DNS Forwarder Configuration
Read the DNS Forwarder for the given tier-0 instance
get Get DNS Forwarder Stats
Get tier-0 DNS forwarder statistics
get Get DNS Forwarder Status
Get current status of tier-0 DNS forwarder
post Perform DNS Forwarder Action
Perform the specified DNS forwarder action
get Query Nameserver
Resolve a given address via the dns forwarder at Tier0
put Update DNS Forwarder
Update the DNS Forwarder
patch Update DNS Forwarder
Update the DNS Forwarder
Flood Protection Profile Bindings
put Create Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router
delete Delete Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-0 Logical Router
get Get Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-0 Logical Router
patch Update Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router
Gateway Firewall
get Get Gateway Firewall Rules
Get list of gateway policies with rules that belong to the specific Tier-0 logical router.
Groups
put Create Group
Create or update Group under specified Tier-0
delete Delete Group
Deletes Group under Tier-0
get Get Group
Read Tier-0 Group
get Get Group IP Members
Get IP addresses that belong to this Tier-0 Group
get Get Group VM List
Get Virtual machines that belong to this Tier-0 Group
get List Groups
List Groups for Tier-0
patch Update Group
Create or update Group under specified Tier-0
Locale Services
put Create Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
put Create Locale Services
Create or update a Tier-0 locale-services
put Create Service Instance
Create service instance
put Create Service Interface
Create a service interface
put Create Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
delete Delete Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-0 Logical Router LocaleServices
delete Delete Locale Services
Delete Tier-0 locale-services
delete Delete Service Instance
Delete policy service instance
delete Delete Service Interface
Delete service interface
delete Delete Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-0 Logical Router LocaleServices
get Get Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
get Get Gateway Firewall Rules
Get list of gateway policies with rules that belong to the specific Tier-0 LocalServices.
get Get Locale Services
Read Tier-0 locale-services
get Get Service Instance
Read service instance
get Get Service Instance Stats
Get statistics for all runtimes associated with this PolicyServiceInstance
get Get Service Interface
Read service interface
get Get Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
get List All Service Instances
Read all service instance objects under a tier-0
get List Locale Services
List Tier-0 locale-services
get List Service Interfaces
List Service Interfaces
post Renew Auth Tokens For Policy Service
Renew the authentication tokens
patch Update Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
patch Update Locale Services
Create or update a tier-0 locale-services
patch Update Service Instance
Create service instance
patch Update Service Interface
Create or update a Tier-0 interface
patch Update Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
Locale Services BGP
put Create BGP Neighbor Config
Create or update a BGP neighbor config
put Create BGP Routing
Create or update a BGP routing config
delete Delete BGP Neighbor Config
Delete BGP neighbor config
get Get BGP Neighbor Advertised Routes
Get BGP neighbor advertised routes
get Get BGP Neighbor Advertised Routes CSV
Get BGP neighbor advertised routes in CSV format
get Get BGP Neighbor Config
Read BGP neighbor config
get Get BGP Neighbor Routes
Get routes learned by BGP neighbor
get Get BGP Neighbor Routes CSV
Get routes learned by BGP neighbor in CSV format
get Get BGP Routing
Read BGP routing config
get List BGP Neighbor Configs
List BGP neighbor configurations
patch Update BGP Neighbor Config
Create or update a BGP neighbor config
patch Update BGP Routing
Create or update BGP routing config
Locale Services BYOD
put Create BYOD Service Instance
Create service instance
put Create BYOD Service Instance Endpoint
Create service instance endpoint
delete Delete BYOD Service Instance
Delete BYOD policy service instance
delete Delete BYOD Service Instance Endpoint
Delete policy service instance endpoint
get Get BYOD Service Instance
Read byod service instance
get Get BYOD Service Instance Endpoint
Read service instance endpoint
get List BYOD Service Instance Endpoints
List all service instance endpoint
get List BYOD Service Instances
Read all BYOD service instance objects under a tier-0
patch Update BYOD Service Instance
Create service instance
patch Update BYOD Service Instance Endpoint
Create service instance endpoint
Locale Services IPsec
get Get IPsec VPN Session Stats
Get IPSec VPN session statistics.
Locale Services IPsec VPN
put Create IPsec VPN Interface
Create or fully replace IPSec VPN service
put Create IPsec VPN Local Endpoint
Create or fully replace IPSec VPN local endpoint
put Create IPsec VPN Session
Create or fully replace IPSec VPN session
delete Delete IPsec VPN Interface
Delete IPSec VPN service
delete Delete IPsec VPN Local Endpoint
Delete IPSec VPN local endpoint
delete Delete IPsec VPN Session
Delete IPSec VPN session
get Get IPsec VPN Interface
Get IPSec VPN service
get Get IPsec VPN Local Endpoint
Get IPSec VPN local endpoint
get Get IPsec VPN Peer Config
Get IPSec VPN configuration for the peer site
get Get IPsec VPN Session
Get IPSec VPN Session
get Get IPsec VPN Session Status
Get IPSec VPN session detailed status.
get Get IPsec VPN Session With Sensitive Data
Get IPSec VPN Session
get List IPsec VPN Interfaces
Get IPSec VPN service list result
get List IPsec VPN Local Endpoints
Get IPSec VPN local endpoint list result
get List IPsec VPN Sessions
Get IPSec VPN sessions list result
patch Update IPsec VPN Interface
Create or patch IPSec VPN service
patch Update IPsec VPN Local Endpoint
Create or patch a custom IPSec VPN local endpoint
patch Update IPsec VPN Session
Create or patch an IPSec VPN session
Locale Services Interfaces
put Create Interface
Create or update a Tier-0 interface
delete Delete Interface
Delete Tier-0 interface
get Get Interface
Read Tier-0 interface
get Get Interface Statistics
Get segment statistics information
get List Interfaces
List Tier-0 Interfaces
patch Update Interface
Create or update a Tier-0 interface
Locale Services L2VPN
put Create L2VPN
Create or replace an L2Vpn
put Create L2VPN Service
Create or fully replace L2VPN service
put Create L2VPN Session
Create or fully replace L2VPN session
post Create L2VPN Session From Peer Code
Create or patch an L2VPN session from Peer Codes
delete Delete L2VPN
Delete an L2Vpn
delete Delete L2VPN Service
Delete L2VPN service
delete Delete L2VPN Session
Delete L2VPN session
get Get L2VPN
Read an L2Vpn
get Get L2VPN Context
Read an L2Vpn Context
get Get L2VPN Peer Config
Get Peer Config for L2Vpn
get Get L2VPN Service
Get L2VPN service
get Get L2VPN Session
Get L2VPN Session
get Get L2VPN Session Peer Config
Get L2VPN session configuration for the peer site
get Get L2VPN Session Stats
Get L2VPN session statistics.
get Get L2VPN Session Status
Get L2VPN session detailed status.
get Get L2VPN Stats
Get L2Vpn statistics
get List L2VPN Services
Get L2VPN service list result
get List L2VPN Sessions
Get L2VPN sessions list result
get List L2VPNs
List L2Vpns
patch Update L2VPN
Create or patch an L2Vpn
patch Update L2VPN Service
Create or patch L2VPN service
patch Update L2VPN Session
Create or patch an L2VPN session
Locale Services L3VPN
put Create L3VPN
Create or replace an L3Vpn
delete Delete L3VPN
Delete an L3Vpn
get Get L3VPN
Read an L3Vpn
get Get L3VPN Peer Config
Download L3Vpn Config for Remote Site
get Get L3VPN Sessions
Read the L3Vpn Context
get Get L3VPN Statistics
Get L3Vpn statistics
get Get L3VPN With Sensitve Data
Read an L3Vpn
get List L3VPN Sessions
List L3Vpns
patch Update L3VPN
Create or patch an L3Vpn
Locale Services Virtual Endpoints
put Create Virtual Endpoint
Create or update virtual endpoint
delete Delete Virtual Endpoint
Delete virtual endpoint
get Get Virtual Endpoint
Read virtual endpoint
get List Virtual Endpoints
List all virtual endpoints
patch Update Virtual Endpoint
Create or update virtual endpoint
NAT
put Create NAT Rule
Update NAT Rule
delete Delete NAT Rule
Delete NAT Rule
get Get NAT Rule
Get NAT Rule
get Get NAT Rule Stats
Get NAT Rule Statistics
get Get NAT Rules Stats
List NAT Rules Statistics
get List NAT Rules
List NAT Rules
patch Update NAT Rule
Create or update a NAT Rule on tier-0
Properties
put Create Tier 0
Create or update a Tier-0
delete Delete Tier 0
Delete Tier-0
get Get Tier 0
Read Tier-0
get List Tier 0s
List Tier-0s
patch Update Tier 0
Create or update a Tier-0
Route Maps
delete Delete Route Map
Delete a route map
get List All Route Maps
List route maps
Routing Table
get Get Routing Table
Get routing table from tier-0
Session Timer Profile Bindings
put Create Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router
delete Delete Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-0 Logical Router
get Get Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-0 Logical Router
patch Update Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router
State
get Get State
Get Tier0 state

Tier 1s

DNS Forwarder
delete Delete DNS Forwarder Config
Delete DNS configuration for tier-1 instance
get Get DNS Forwarder
Read the DNS Forwarder for the given tier-1 instance
get Get DNS Forwarder Stats
Get tier-1 DNS forwarder statistics
get Get DNS Forwarder Status
Get current status of tier-1 DNS forwarder
post Perform DNS Forwarder Action
Perform the specified DNS forwarder action
get Query Nameserver
Resolve a given address via the dns forwarder at Tier1
patch Update DNS Forwarder
Create or update the DNS Forwarder
put Update DNS Forwarder
Create or update the DNS Forwarder
Flood Protection Profile Bindings
put Create Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router
delete Delete Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-1 Logical Router
get Get Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-1 Logical Router
patch Update Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router
Gateway Firewall
get Get Gateway Firewall
Get list of gateway policies with rules that belong to the specific Tier-1.
IPFIX Switch Collection Instances
delete Delete IPFIX Collection Instance
Delete IPFIX Switch Collection Instance
get Get IPFIX Collection Instance
Get IPFIX Switch Collection Instance
get List IPFIX Collection Instances
List IPFIX Switch Collection Instances
put Pcreate IPFIX Collection Instance
Create or Replace IPFIX switch collection instance
patch Update IPFIX Collection Instance
Patch IPFIX switch collection instance
Locale Services
put Create Interface
Create or update a tier-1 interface
put Create Locale Services
Create or update a Tier-1 locale-services
put Create Service Instance
Create Tier1 service instance
put Create Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
delete Delete Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-1 Logical Router LocaleServices
delete Delete Interface
Delete Tier-1 interface
delete Delete Locale Services
Delete Tier-1 locale-services
delete Delete Service Instance
Delete Tier1 policy service instance
delete Delete Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices
get Get Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
get Get IPsec VPN Session Stats
Get IPSec VPN session statistics.
get Get IPsec VPN Session Status
Get IPSec VPN session detailed status.
get Get Interface
Read Tier-1 interface
get Get Interface Stats
Get segment statistics information
get Get Locale Services
Read Tier-1 locale-services
get Get Locale Services Gateway Firewall
Get list of gateway policies with rules that belong to the specific Tier-1 LocalServices.
get Get Service Instance
Read Tier1 service instance
get Get Service Instance Stats
Get statistics for all runtimes associated with this Tier1 PolicyServiceInstance
get Get Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
get List Locale Services
List Tier-1 locale-services
get List Service Instances
Read all service instance objects under a tier-1
put Update Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
patch Update Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
patch Update Interface
Create or update a Tier-1 interface
patch Update Locale Services
Create or update a Tier-1 locale-services
patch Update Service Instance
Create Tier1 service instance
patch Update Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
Locale Services Interfaces
get List Interfaces
List Tier-1 interfaces
NAT
put Create NAT Rule
Update NAT Rule
delete Delete NAT Rule
Delete NAT Rule
get Get NAT Rule
Get NAT Rule
get Get NAT Rule Stats
Get NAT Rule Statistics
get List NAT Rules
List NAT Rules
get List NAT Rules Stats
List NAT Rules Statistics
patch Update NAT Rule
Create or update a Nat Rule
Properties
put Create Tier1
Create or update tier-1 configuration
delete Delete Tier1
Delete Tier-1 configuration
get Get Tier1
Read Tier-1 configuration
patch Update Tier1
Create or update Tier-1 configuration
Segments
put Create Port Discovery Binding
Update Port Discovery Profile Binding Map
put Create Port Monitoring Binding
Update Port Monitoring Profile Binding Map
put Create Port QoS Profile Binding
Update Port QoS Profile Binding Map
put Create Port Security Profile Binding
Create or replace the port security profile binding map
put Create Segment
Create or update a segment
put Create Segment Discovery Binding
Update Segment Monitoring Profile Binding Map
put Create Segment Discovery Binding
Update Segment Discovery Profile Binding Map
put Create Segment Port
Create or update a Tier-1 segment port
put Create Segment QoS Binding
Update Segment QoS Profile Binding Map
put Create Segment Security Profile Bindings
Create or replace segment security profile binding map
put Create Static ARP Config
Create or update a static ARP config
delete Delete Port Discovery Binding
Delete Port Discovery Profile Binding Profile
delete Delete Port Monitoring Binding
Delete Port Monitoring Profile Binding Profile
delete Delete Port QoS Profile Binding
Delete Port QoS Profile Binding Profile
delete Delete Port Security Profile Binding
Delete the port security profile binding map
delete Delete Segment
Delete segment
delete Delete Segment Discovery Binding
Delete Segment Discovery Profile Binding Profile
delete Delete Segment Discovery Binding
Delete Segment Monitoring Profile Binding Profile
delete Delete Segment Port
Delete a Tier-1 segment port
delete Delete Segment QoS Binding
Delete Segment QoS Profile Binding Profile
delete Delete Segment Security Profile Binding
Delete segment security profile binding map
delete Delete Static ARP Config
Delete static ARP config
delete Force Delete Segment
Force delete segment
get Get Port Discovery Binding
Get Port Discovery Profile Binding Map
get Get Port Monitoring Binding
Get Port Monitoring Profile Binding Map
get Get Port QoS Profile Binding
Get Port QoS Profile Binding Map
get Get Port Security Profile Binding
Get port security profile binding map
get Get Segment
Read segment
get Get Segment Discovery Binding
Get Segment Discovery Profile Binding Map
get Get Segment Discovery Binding
Get Segment Monitoring Profile Binding Map
get Get Segment Port
Get Tier-1 segment port by ID
get Get Segment Port Stats
Get segment statistics information
get Get Segment Port Stats
Get segment port statistics information
get Get Segment QoS Binding
Get Segment QoS Profile Binding Map
get Get Segment Security Profile Binding
Get segment security profile binding map
get Get Static ARP Config
Read static ARP config
get List Port Discovery Bindings
List Port Discovery Profile Binding Maps
get List Port Monitoring Bindings
List Port Monitoring Profile Binding Maps
get List Port QoS Profile Bindings
List Port QoS Profile Binding Maps
get List Port Security Profile Bindings
List port security profile binding maps
get List Segment Discovery Bindings
List Segment Discovery Profile Binding Maps
get List Segment Monitoring Binding
List Segment Monitoring Profile Binding Maps
get List Segment Ports
List Tier-1 segment ports
get List Segment QoS Bindings
List Segment QoS Profile Binding Maps
get List Segment Security Profile Bindings
List segment security profile binding maps
get List Segments
List all segments under tier-1 instance
patch Update Port Discovery Binding
Create Port Discovery Profile Binding Map
patch Update Port Monitoring Binding
Create Port Monitoring Profile Binding Map
patch Update Port QoS Profile Binding
Create Port QoS Profile Binding Map
patch Update Port Security Profile Binding
Patch port security profile binding map
patch Update Segment
Create or update a segment
patch Update Segment Discovery Binding
Create Segment Discovery Profile Binding Map
patch Update Segment Discovery Binding
Create Segment Monitoring Profile Binding Map
patch Update Segment Port
Patch a Tier-1 segment port
patch Update Segment QoS Binding
Create Segment QoS Profile Binding Map
patch Update Segment Security Profile Binding
Patch segment security profile binding map
patch Update Static ARP Config
Create or update a static ARP config
Session Timer Profile Bindings
put Create Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router
delete Delete Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-1 Logical Router
get Get Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-1 Logical Router
patch Update Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router
State
get Get State
Get Tier1 state
Static Routes
put Create Static Route
Create or update a Tier-1 static routes
delete Delete Static Route
Delete Tier-1 static routes
get Get Static Route
Read Tier-1 static routes
get List Static Routes
List Tier-1 Static Routes
patch Update Static Route
Create or update a Tier-1 static routes

UI Views

Properties
post Create UI View
Creates a new View.
put Create UI View
Update View
delete Delete UI View
Delete View
get Get UI View
Returns View Information
get List UI Views
Returns the Views based on query criteria defined in ViewQueryParameters.
Widget Configurations
post Create Widget Configuration
Creates a new Widget Configuration.
put Create Widget Configuration
Update Widget Configuration
delete Delete Widget Configuration
Delete Widget Configuration
get Get Widget Configuration
Returns Widget Configuration Information
get List Widget Configurations
Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.
Feedback

Was this page helpful?