Methods:

API Description API Path
Federation > Infra > Federation Configuration
Read federation config
GET /global-manager/api/v1/global-infra/federation-config
Federation > Infra > Federation Configuration
List overridden resources
GET /global-manager/api/v1/global-infra/overridden-resources
Federation > Infra > Global Managers
Get Global Managed operational state
GET /global-manager/api/v1/gm-operational-state
Federation > Infra > Global Managers
List Global Managers
GET /global-manager/api/v1/global-infra/global-managers
Federation > Infra > Global Managers
Delete a Global Manager under Infra
DELETE /global-manager/api/v1/global-infra/global-managers/<global-manager-id>
Federation > Infra > Global Managers
Read a Global Manager
GET /global-manager/api/v1/global-infra/global-managers/<global-manager-id>
Federation > Infra > Global Managers
Create or patch a Global Manager
PATCH /global-manager/api/v1/global-infra/global-managers/<global-manager-id>
Federation > Infra > Global Managers
Create or fully replace a Global Manager under infra
PUT /global-manager/api/v1/global-infra/global-managers/<global-manager-id>
Federation > Infra > Global Managers
List resources pending to be cleaned from set of sites.
GET /global-manager/api/v1/global-infra/site-cleanup-pending
Federation > Infra > Global Managers
Get Upgrade summary
GET /global-manager/api/v1/global-infra/upgrade-summary
Federation > Infra > Onboarding
Start or Check on-boarding for a Site
POST /global-manager/api/v1/global-infra/sites/<site-id>/onboarding?action=start_onboarding
Federation > Infra > Onboarding
Check Onboarding configuration conflicts
POST /global-manager/api/v1/global-infra/sites/<site-id>/onboarding?action=check_conflict
Federation > Infra > Onboarding
Fetch conflicting entities summary for a Site
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/feature-summary
Federation > Infra > Onboarding
Fetch feature entities summary details for a Site
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/invalid-config-details
Federation > Infra > Onboarding
Get Onboarding Preferences
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/preferences
Federation > Infra > Onboarding
Update Onboarding Preferences
PUT /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/preferences
Federation > Infra > Onboarding
Get Onboarding status
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/status
Federation > Infra > Sites
Get span for an entity with specified path
GET /global-manager/api/v1/global-infra/span
Federation > Local Manager > Full Synchronization
List full sync states
GET /global-manager/api/v1/global-infra/full-sync-states
Federation > Local Manager > Full Synchronization
Get full sync state
GET /global-manager/api/v1/global-infra/full-sync-states/<full-sync-id>
Management Plane API > NSX Component Administration > Appliance Management
Read the Appliance Proxy service properties
GET /api/v1/node/services/applianceproxy
GET /api/v1/transport-nodes/<transport-node-id>/node/services/applianceproxy
GET /api/v1/cluster/<cluster-node-id>/node/services/applianceproxy
Management Plane API > NSX Component Administration > Appliance Management
Restart, start or stop the Appliance Proxy Service
POST /api/v1/node/services/applianceproxy?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/applianceproxy?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/applianceproxy?action=restart|start|stop
Management Plane API > NSX Component Administration > Appliance Management
Read the Appliance Proxy service status
GET /api/v1/node/services/applianceproxy/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/applianceproxy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/applianceproxy/status
Policy
Get the list of services where the given group is consumed.
GET /global-manager/api/v1/global-infra/group-service-associations
Policy > Authorization > Object Permissions
Get effective object permissions to object specified by path for current user.
GET /global-manager/api/v1/aaa/effective-permissions (Experimental)
Policy > Authorization > Object Permissions
Delete object-permissions entries
DELETE /global-manager/api/v1/aaa/object-permissions (Experimental)
Policy > Authorization > Object Permissions
Get list of Object-level RBAC entries.
GET /global-manager/api/v1/aaa/object-permissions (Experimental)
Policy > Authorization > Object Permissions
Create/update object permission mappings
PATCH /global-manager/api/v1/aaa/object-permissions (Experimental)
Policy > Infra > Certificates > Certificates
Return All the User-Facing Components' Certificates
GET /global-manager/api/v1/global-infra/certificates
Policy > Infra > Certificates > Certificates
Delete Certificate for the Given Certificate ID
DELETE /global-manager/api/v1/global-infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certificates
Show Certificate Data for the Given Certificate ID
GET /global-manager/api/v1/global-infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certificates
Add a New Certificate
PATCH /global-manager/api/v1/global-infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certificates
Add a New Certificate
PUT /global-manager/api/v1/global-infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certification Revocation List
Return All Added CRLs
GET /global-manager/api/v1/global-infra/crls
Policy > Infra > Certificates > Certification Revocation List
Delete a CRL
DELETE /global-manager/api/v1/global-infra/crls/<crl-id>
Policy > Infra > Certificates > Certification Revocation List
Show CRL Data for the Given CRL id.
GET /global-manager/api/v1/global-infra/crls/<crl-id>
Policy > Infra > Certificates > Certification Revocation List
Create or patch a Certificate Revocation List
PATCH /global-manager/api/v1/global-infra/crls/<crl-id>
Policy > Infra > Certificates > Certification Revocation List
Create a new Certificate Revocation List
POST /global-manager/api/v1/global-infra/crls/<crl-id>?action=import
Policy > Infra > Certificates > Certification Revocation List
Create or fully replace a Certificate Revocation List
PUT /global-manager/api/v1/global-infra/crls/<crl-id>
Policy > Infra > Constraints
List tenant Constraints.
GET /global-manager/api/v1/global-infra/constraints
Policy > Infra > Constraints
Delete tenant Constraint.
DELETE /global-manager/api/v1/global-infra/constraints/<constraint-id>
Policy > Infra > Constraints
Read tenant Constraint.
GET /global-manager/api/v1/global-infra/constraints/<constraint-id>
Policy > Infra > Constraints
Create or update tenant Constraint
PATCH /global-manager/api/v1/global-infra/constraints/<constraint-id>
Policy > Infra > Constraints
Create or update tenant Constraint
PUT /global-manager/api/v1/global-infra/constraints/<constraint-id>
Policy > Infra > Domains > Domain
List domains for infra
GET /global-manager/api/v1/global-infra/domains
Policy > Infra > Domains > Domain
Delete Domain and all the entities contained by this domain
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>
Policy > Infra > Domains > Domain
Read domain
GET /global-manager/api/v1/global-infra/domains/<domain-id>
Policy > Infra > Domains > Domain
Patch a domain
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>
Policy > Infra > Domains > Domain
Create or update a domain
PUT /global-manager/api/v1/global-infra/domains/<domain-id>
Policy > Infra > Domains > Domain Deployment Maps
List Domain Deployment maps for infra
GET /global-manager/api/v1/global-infra/domains/<domain-id>/domain-deployment-maps
Policy > Infra > Domains > Domain Deployment Maps
Delete Domain Deployment Map
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Domains > Domain Deployment Maps
Read a DomainDeploymentMap
GET /global-manager/api/v1/global-infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Domains > Domain Deployment Maps
Patch Domain Deployment Map under infra
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Domains > Domain Deployment Maps
Create a new Domain Deployment Map under infra
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Enforcement Points
List enforcementpoints under Site
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points
Policy > Infra > Enforcement Points
Full sync EnforcementPoint from Site
POST /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcement-point-id>?action=full-sync
Policy > Infra > Enforcement Points
Delete EnforcementPoint from Site
DELETE /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
Read an Enforcement Point under Infra/Site
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
Patch a new Enforcement Point under Site
PATCH /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
Reload an Enforcement Point under Site
POST /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>?action=reload
Policy > Infra > Enforcement Points
Create/update a new Enforcement Point under Site
PUT /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
List Edge Clusters under an Enforcement Point
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters
Policy > Infra > Enforcement Points
Read a Edge Cluster under an Enforcement Point
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>
Policy > Infra > Enforcement Points
List Edge Nodes under an Enforcement Point, Edge Cluster
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>/edge-nodes
Policy > Infra > Enforcement Points
Read a Edge Node under an Enforcement Point, Edge Cluster
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>/edge-nodes/<edge-node-id>
Policy > Infra > Enforcement Points
List Transport Zones under an Enforcement Point
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones
Policy > Infra > Enforcement Points
Read a Transport Zone under an Enforcement Point
GET /global-manager/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<transport-zone-id>
Policy > Infra > Federation
Read Global Manager config along with sensitive data
GET /global-manager/api/v1/global-infra/global-manager-config?action=show-sensitive-data
Policy > Infra > Federation
Create or patch Global Manager Config
PATCH /global-manager/api/v1/global-infra/global-manager-config
Policy > Infra > Federation
Create or fully replace Global Manager Config
PUT /global-manager/api/v1/global-infra/global-manager-config
Policy > Infra > Hierarchical API
Read infra
GET /global-manager/api/v1/global-infra
Policy > Infra > Hierarchical API
Update the infra including all the nested entities
PATCH /global-manager/api/v1/global-infra
Policy > Infra > Hierarchical API
Update the infra including all the nested entities
PUT /global-manager/api/v1/global-infra
Policy > Infra > Labels
List labels for infra
GET /global-manager/api/v1/global-infra/labels
Policy > Infra > Labels
Delete PolicyLabel object
DELETE /global-manager/api/v1/global-infra/labels/<label-id>
Policy > Infra > Labels
Read lable
GET /global-manager/api/v1/global-infra/labels/<label-id>
Policy > Infra > Labels
Patch an existing label object
PATCH /global-manager/api/v1/global-infra/labels/<label-id>
Policy > Infra > Labels
Create or replace label
PUT /global-manager/api/v1/global-infra/labels/<label-id>
Policy > Infra > Realized State
List All alarms in the system
GET /global-manager/api/v1/global-infra/realized-state/alarms
Policy > Infra > Realized State
Get list of realized objects associated with intent object
GET /global-manager/api/v1/global-infra/realized-state/realized-entities
Policy > Infra > Realized State
Refresh all realized entities associated with the intent-path
POST /global-manager/api/v1/global-infra/realized-state/realized-entity?action=refresh
Policy > Infra > Realized State
Get consolidated status of an intent object
GET /global-manager/api/v1/global-infra/realized-state/status
Policy > Infra > Sites
List Sites
GET /global-manager/api/v1/global-infra/sites
Policy > Infra > Sites
Delete a site
DELETE /global-manager/api/v1/global-infra/sites/<site-id>
Policy > Infra > Sites
Read a site
GET /global-manager/api/v1/global-infra/sites/<site-id>
Policy > Infra > Sites
Create or patch Site
PATCH /global-manager/api/v1/global-infra/sites/<site-id>
Policy > Infra > Sites
Create or fully replace a Site under infra
PUT /global-manager/api/v1/global-infra/sites/<site-id>
Policy > Infra > Sites
Returns the certificate of the listener
GET /global-manager/api/v1/global-infra/sites/listener_certificate
Policy > Inventory > Context Profiles
Get PolicyContextProfiles
GET /global-manager/api/v1/global-infra/context-profiles
Policy > Inventory > Context Profiles
Delete Policy Context Profile
DELETE /global-manager/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Context Profiles
Get PolicyContextProfile
GET /global-manager/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Context Profiles
Create PolicyContextProfile
PATCH /global-manager/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Context Profiles
Create PolicyContextProfile
PUT /global-manager/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Context Profiles
List Policy Context Profile supported attributes and sub-attributes
GET /global-manager/api/v1/global-infra/context-profiles/attributes
Policy > Inventory > Context Profiles
Update custom object attribute value list for given attribute key
PATCH /global-manager/api/v1/global-infra/context-profiles/custom-attributes
Policy > Inventory > Context Profiles
Adds/Removes custom attribute values from list
POST /global-manager/api/v1/global-infra/context-profiles/custom-attributes
Policy > Inventory > Groups > Group Members
Get member types for a given Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/member-types
Policy > Inventory > Groups > Group Members
Get consolidated effective IPAddress translated from this group across site
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/consolidated-effective-ip-addresses
Policy > Inventory > Groups > Group Members
Get IP addresses that belong to this Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/ip-addresses
Policy > Inventory > Groups > Group Members
Get logical ports that belong to this Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/logical-ports
Policy > Inventory > Groups > Group Members
Get logical switches that belong to this Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/logical-switches
Policy > Inventory > Groups > Group Members
Get segment ports that belong to this Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/segment-ports
Policy > Inventory > Groups > Group Members
Get segments that belong to this Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/segments
Policy > Inventory > Groups > Group Members
Get Virtual Network Interface instances that belong to this Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/vifs
Policy > Inventory > Groups > Group Members
Get Virtual machines that belong to this Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/virtual-machines
Policy > Inventory > Groups > Group Members
Get tags used to define conditions inside a Group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/tags
Policy > Inventory > Groups > Group Members
Get groups for which the given object is a member
GET /global-manager/api/v1/global-infra/group-associations
Policy > Inventory > Groups > Group Members
Get groups for which the given IP address is a member
GET /global-manager/api/v1/global-infra/ip-address-group-associations
Policy > Inventory > Groups > Group Members
Get groups for which the given VM is a member
GET /global-manager/api/v1/global-infra/virtual-machine-group-associations
Policy > Inventory > Groups > Group Members
Get groups for which the given VIF is a member
GET /global-manager/api/v1/global-infra/virtual-network-interface-group-associations
Policy > Inventory > Groups > Groups
List Groups for a domain
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups
Policy > Inventory > Groups > Groups
Delete Group
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Read group
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Patch a group
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Create or update a group
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Delete Group External ID Expression
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/external-id-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group external ID expression
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/external-id-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove external id based members from/to a Group
POST /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/external-id-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Delete Group IPAddressExpression
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/ip-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group IP Address expression
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/ip-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove IP Addresses from/to a Group
POST /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/ip-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Delete Group MACAddressExpression
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/mac-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group MAC Address expression
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/mac-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove MAC Addresses from/to a Group
POST /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/mac-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Delete Group Path Expression
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/path-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group path expression
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/path-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove path based members from/to a Group
POST /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/path-expressions/<expression-id>
Policy > Inventory > Services
List Services for infra
GET /global-manager/api/v1/global-infra/services
Policy > Inventory > Services
Delete Service
DELETE /global-manager/api/v1/global-infra/services/<service-id>
Policy > Inventory > Services
Read a service
GET /global-manager/api/v1/global-infra/services/<service-id>
Policy > Inventory > Services
Patch a Service
PATCH /global-manager/api/v1/global-infra/services/<service-id>
Policy > Inventory > Services
Create or update a Service
PUT /global-manager/api/v1/global-infra/services/<service-id>
Policy > Inventory > Services
List Service entries for the given service
GET /global-manager/api/v1/global-infra/services/<service-id>/service-entries
Policy > Inventory > Services
Delete Service entry
DELETE /global-manager/api/v1/global-infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Inventory > Services
Service entry
GET /global-manager/api/v1/global-infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Inventory > Services
Patch a ServiceEntry
PATCH /global-manager/api/v1/global-infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Inventory > Services
Create or update a ServiceEntry
PUT /global-manager/api/v1/global-infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Networking > Connectivity > Segment > Intersite-Forwarder
Get infra segment cross site forwarder placement and HA status
GET /global-manager/api/v1/global-infra/segments/<segment-id>/inter-site-forwarder/site-span-info
Policy > Networking > Connectivity > Segment > Intersite-Forwarder
Get infra segment cross site traffic statistics
GET /global-manager/api/v1/global-infra/segments/<segment-id>/inter-site-forwarder/status
Policy > Networking > Connectivity > Segment > Intersite-Forwarder
Get segment cross site forwarder placement and HA status
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/inter-site-forwarder/site-span-info
Policy > Networking > Connectivity > Segment > Intersite-Forwarder
Get segment cross site traffic statistics
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/inter-site-forwarder/status
Policy > Networking > Connectivity > Segment > MAC Table
Get infra segment MAC table in CSV
GET /global-manager/api/v1/global-infra/segments/<segment-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segment > MAC Table
Get infra segment MAC table
GET /global-manager/api/v1/global-infra/segments/<segment-id>/mac-table
Policy > Networking > Connectivity > Segment > MAC Table
Get Tier-1 segment MAC table
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/mac-table
Policy > Networking > Connectivity > Segment > MAC Table
Get Tier-1 segment MAC table in CSV
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segment > Ports > MAC Table
Get infra segment port MAC table in CSV
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segment > Ports > MAC Table
Get MAC table for infra segment port
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/mac-table
Policy > Networking > Connectivity > Segment > Ports > MAC Table
Get MAC table for tier-1 segment port
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/mac-table
Policy > Networking > Connectivity > Segment > Ports > MAC Table
Get tier-1 segment port MAC table in CSV
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segment > Ports > State
Get infra segment port state
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/state
Policy > Networking > Connectivity > Segment > Ports > State
Get tier-1 segment port state
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/state
Policy > Networking > Connectivity > Segment > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Group Monitoring Profile Binding Map.
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segment > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Infra Port Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segment > Segment Profiles > Monitoring Profile Binding
Get Infra Segment Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segment > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Port Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segment > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Segment Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segment > State
Get tier-1 segments by configuration state
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/state
Policy > Networking > Connectivity > Segment > Statistics
Get infra segment port statistics information
GET /global-manager/api/v1/global-infra/segments/<segments-id>/ports/<port-id>/statistics
Policy > Networking > Connectivity > Segment > Tep Table
Get infra segment TEP table
GET /global-manager/api/v1/global-infra/segments/<segment-id>/tep-table
Policy > Networking > Connectivity > Segment > Tep Table
Get tier-1 segment TEP table in CSV
GET /global-manager/api/v1/global-infra/segments/<segment-id>/tep-table?format=csv
Policy > Networking > Connectivity > Segment > Tep Table
Get tier-1 segment TEP table in CSV
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/tep-table?format=csv
Policy > Networking > Connectivity > Segment > Tep Table
Get tier-1 segment TEP table
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/tep-table
Policy > Networking > Connectivity > Segments > Ports
List infra segment ports
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports
Policy > Networking > Connectivity > Segments > Ports
Get infra segment port by ID
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
List Tier-1 segment ports
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports
Policy > Networking > Connectivity > Segments > Ports
Get Tier-1 segment port by ID
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Group discovery profile binding map
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Group discovery profile binding map
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Group discovery profile binding map
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create or update Group discovery profile binding map
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Group discovery profile binding map
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Infra Port Discovery Profile Binding Maps
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Infra Port Discovery Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Infra Segment Discovery Profile Binding Maps
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Segment Discovery Profile Binding Profile
DELETE /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Infra Segment Discovery Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create Infra Segment Discovery Profile Binding Map
PATCH /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Infra Segment Discovery Profile Binding Map
PUT /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Port Discovery Profile Binding Maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Port Discovery Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Segment Discovery Profile Binding Maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Segment Discovery Profile Binding Profile
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Segment Discovery Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create Segment Discovery Profile Binding Map
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Segment Discovery Profile Binding Map
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
List IP Discovery Profiles
GET /global-manager/api/v1/global-infra/ip-discovery-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Delete IP Discovery Profile
DELETE /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Get IP Discovery Profile
GET /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Create IP Discovery Profile
PATCH /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Update IP Discovery Profile
PUT /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
List Mac Discovery Profiles
GET /global-manager/api/v1/global-infra/mac-discovery-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Delete Mac Discovery Profile
DELETE /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Get Mac Discovery Profile
GET /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Create Mac Discovery Profile
PATCH /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Update Mac Discovery Profile
PUT /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Infra Port Monitoring Profile Binding Maps
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Infra Port Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Infra Segment Monitoring Profile Binding Maps
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Delete Infra Segment Monitoring Profile Binding Profile
DELETE /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Infra Segment Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Create Infra Segment Monitoring Profile Binding Map
PATCH /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Update Infra Segment Monitoring Profile Binding Map
PUT /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Port Monitoring Profile Binding Maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Port Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Segment Monitoring Profile Binding Maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Delete Segment Monitoring Profile Binding Profile
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Segment Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Create Segment Monitoring Profile Binding Map
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Update Segment Monitoring Profile Binding Map
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Port QoS Profile Binding Maps
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Port QoS Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Segment QoS Profile Binding Maps
GET /global-manager/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Delete Segment QoS Profile Binding Profile
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Segment QoS Profile Binding Map
GET /global-manager/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Create Segment QoS Profile Binding Map
PATCH /global-manager/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Update Segment QoS Profile Binding Map
PUT /global-manager/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Port QoS Profile Binding Maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Port QoS Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Segment QoS Profile Binding Maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Delete Segment QoS Profile Binding Profile
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Segment QoS Profile Binding Map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Create Segment QoS Profile Binding Map
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Update Segment QoS Profile Binding Map
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
List QoS Profiles
GET /global-manager/api/v1/global-infra/qos-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Delete QoS profile
DELETE /global-manager/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Details of QoS profile
GET /global-manager/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Patch QoS profile.
PATCH /global-manager/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Create or Replace QoS profile.
PUT /global-manager/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Security Profile Binding
Patch segment security profile binding map
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List infra segment port security profile binding maps
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get infra segment port security profile binding map
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List infra segment security profile binding maps
GET /global-manager/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Delete infra segment security profile binding map
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get infra segment security profile binding map
GET /global-manager/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Patch infra segment security profile binding map
PATCH /global-manager/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Create or replace infra segment security profile binding map
PUT /global-manager/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List port security profile binding maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get port security profile binding map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List segment security profile binding maps
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Delete segment security profile binding map
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get segment security profile binding map
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Create or replace segment security profile binding map
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
List segment security profiles
GET /global-manager/api/v1/global-infra/segment-security-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
DELETE segment security profile
DELETE /global-manager/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
GET Segment security profile id
GET /global-manager/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
PATCH segment security profile id
PATCH /global-manager/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
PUT segment security profile id
PUT /global-manager/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
List SpoofGuard profiles
GET /global-manager/api/v1/global-infra/spoofguard-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Delete SpoofGuard profile
DELETE /global-manager/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Get SpoofGuard profile
GET /global-manager/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Patch SpoofGuard profile
PATCH /global-manager/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Create or replace SpoofGuard profile
PUT /global-manager/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segments
List all segments under infra
GET /global-manager/api/v1/global-infra/segments
Policy > Networking > Connectivity > Segments > Segments
Delete infra segment
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Force delete infra segment
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments
Read infra segment
GET /global-manager/api/v1/global-infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Create or update a segment
PATCH /global-manager/api/v1/global-infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Create or update a segment
PATCH /global-manager/api/v1/global-infra/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments
Create or update a infra segment
PUT /global-manager/api/v1/global-infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Create or update a infra segment
PUT /global-manager/api/v1/global-infra/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments (Fixed)
List all segments under tier-1 instance
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Delete segment
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Force delete segment
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Read segment
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a segment
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a segment
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Delete static ARP config
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Read static ARP config
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a static ARP config
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a static ARP config
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > State
Get infra segment state information
GET /global-manager/api/v1/global-infra/segments/<segments-id>/state
Policy > Networking > Connectivity > Segments > State
Get segment state information
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/state
Policy > Networking > Connectivity > Segments > Statistics
Get infra segment statistics information
GET /global-manager/api/v1/global-infra/segments/<segments-id>/statistics
Policy > Networking > Connectivity > Segments > Statistics
Get infra segments by configuration state
GET /global-manager/api/v1/global-infra/segments/state
Policy > Networking > Connectivity > Segments > Statistics
Get tier-1 segment port statistics information
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/ports/<port-id>/statistics
Policy > Networking > Connectivity > Segments > Statistics
Get segment statistics information
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/statistics
Policy > Networking > Connectivity > Tier-0 Gateways > ARP Proxies
Get Tier-0 Address Resolution Protocol Proxies
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/arp-proxies
Policy > Networking > Connectivity > Tier-0 Gateways > Inter-Site
Get RTEP span and mac address-table
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/inter-site/bgp-summary
Policy > Networking > Connectivity > Tier-0 Gateways > Inter-Site
Get RTEP mesh connectivity status
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/inter-site/status
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Proxies
Get Tier-0 Interface Address Resolution Protocol Proxies
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink)
GET /global-manager/api/v1/global-infra/segments/<segment-id>/arp-table
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink) in CSV format
GET /global-manager/api/v1/global-infra/segments/<segment-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-0 router
GET /global-manager/api/v1/global-infra/segments/<segment-id>/gateway-interface-arp-table
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-0 router in CSV
GET /global-manager/api/v1/global-infra/segments/<segment-id>/gateway-interface-arp-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from tier-0 interface
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from tier-0 interface in CSV format
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > DAD State
Get DAD state for downlink router port on tier-0 router
GET /global-manager/api/v1/global-infra/segments/<segment-id>/gateway-interface-dad-state
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > DAD State
Get DAD status by interface
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/dad-state
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > DAD State
Get DAD status by interface
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/dad-state
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
List Tier-0 Interfaces
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Delete Tier-0 interface
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Read Tier-0 interface
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create or update a Tier-0 interface
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create or update a Tier-0 interface
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
List Service Interfaces
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Delete service interface
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Read service interface
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create or update a Tier-0 interface
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create a service interface
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-0 router
GET /global-manager/api/v1/global-infra/segments/<segment-id>/gateway-interface-statistics
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-0 router
GET /global-manager/api/v1/global-infra/segments/<segment-id>/gateway-interface-statistics/summary
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get tier-0 interface statistics information
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get tier-0 interface statistics summary information
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Read BGP routing config
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update BGP routing config
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update a BGP routing config
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
List BGP neighbor configurations
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Delete BGP neighbor config
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Read BGP neighbor config
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update a BGP neighbor config
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update a BGP neighbor config
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get BGP neighbor advertised routes
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get BGP neighbor advertised routes in CSV format
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get routes learned by BGP neighbor in CSV format
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get routes learned by BGP neighbor
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get BGP neighbor status for the Tier0
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/status
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
List BGP community lists
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Delete a BGP community list
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Read a BGP community list
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Create or update a BGP community list
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Create or update a BGP community list
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Forwarding Table
Get forwarding table from tier-0 in CSV format
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/forwarding-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Forwarding Table
Get forwarding table from tier-0
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/forwarding-table
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
List prefix lists
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Delete a prefix list
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Read a prefix list
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Create or update a prefix list
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Create or update a prefix list
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
List route maps
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Delete a route map
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Read a route map
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Create or update a route map
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Create or update a route map
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Routing Table
Get routing table from tier-0
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/routing-table
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Routing Table
Get routing table from tier-0 in CSV format
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/routing-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > State
Get Tier0 state
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/state
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
List Tier-0 Static Routes
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Delete Tier-0 static routes
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Read Tier-0 static routes
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Create or update a Tier-0 static routes
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Create or update a Tier-0 static routes
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
List StaticRouteBfdPeers
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Delete this StaticRouteBfdPeer and all the entities contained by it.
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Read a StaticRouteBfdPeer
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Create or update a StaticRouteBfdPeer
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Create or update a StaticRouteBfdPeer
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
List Tier-0 Deployment maps
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Delete Tier-0 Deployment Map
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Read a Tier-0 Deployment Map
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Patch a Tier-0 Deployment Map under Tier-0
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Create a new Tier-0 Deployment Map under Tier-0
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
List Tier-0s
GET /global-manager/api/v1/global-infra/tier-0s
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Delete Tier-0
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Read Tier-0
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Create or update a Tier-0
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Create or update a Tier-0
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
List Tier-0 locale-services
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Delete Tier-0 locale-services
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Read Tier-0 locale-services
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Create or update a tier-0 locale-services
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Create or update a Tier-0 locale-services
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > ARP Proxies
Get Tier-1 Address Resolution Protocol Proxies
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/arp-proxies
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Proxies
Get Tier-1 Interface Address Resolution Protocol Proxies
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from tier-1 interface in CSV format
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from tier-1 interface
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink)
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink) in CSV format
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-1 router
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-arp-table
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-1 router in CSV
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-arp-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > DAD State
Get DAD state for downlink router port on tier-1 router
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-dad-state
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
List Tier 1 Service Interfaces
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Delete Tier 1 service interface
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Read Tier 1 service interface
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create or update a Tier-1 service interface
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create a Tier1 service interface
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
List Tier-1 interfaces
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Delete Tier-1 interface
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Read Tier-1 interface
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create or update a Tier-1 interface
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create or update a tier-1 interface
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get tier-1 interface statistics information
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get tier-1 interface statistics summary information
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-1 router
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-statistics
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-1 router
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-statistics/summary
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Forwarding Table
Get forwarding table from tier-1 in CSV format
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/forwarding-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Forwarding Table
Get forwarding table from tier-1
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/forwarding-table
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > State
Get Tier1 state
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/state
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
List Tier-1 Static Routes
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Delete Tier-1 static routes
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Read Tier-1 static routes
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Create or update a Tier-1 static routes
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Create or update a Tier-1 static routes
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
List Tier-1 instances
GET /global-manager/api/v1/global-infra/tier-1s
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Delete Tier-1 configuration
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Read Tier-1 configuration
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Create or update Tier-1 configuration
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Create or update tier-1 configuration
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
List Tier-1 locale-services
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Delete Tier-1 locale-services
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Read Tier-1 locale-services
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Create or update a Tier-1 locale-services
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Create or update a Tier-1 locale-services
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
List DHCP relay config instances
GET /global-manager/api/v1/global-infra/dhcp-relay-configs
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Delete DHCP relay configuration
DELETE /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Read DHCP relay configuration
GET /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Create or update DHCP relay configuration
PATCH /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Create or update DHCP relay configuration
PUT /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
List DHCP server config instances
GET /global-manager/api/v1/global-infra/dhcp-server-configs
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server leases
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/leases
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server state
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/state
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server statistics
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/stats
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server status
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/status
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Delete DHCP server configuration
DELETE /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server configuration
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Create or update DHCP server configuration
PATCH /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Create or update DHCP server configuration
PUT /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings
Read DHCP static binding state
GET /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state
Policy > Networking > IP Management > DHCP > DHCP Static Bindings
Read DHCP static binding state
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
List all DHCP static bindings
GET /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Delete DHCP static binding
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Read DHCP static binding
GET /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Create or update DHCP static binding
PATCH /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Create or update DHCP static binding
PUT /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
List all DHCP static bindings
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Delete DHCP static binding
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Read DHCP static binding
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Create or update DHCP static binding
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Create or update DHCP static binding
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
List Dns Forwarder Zones
GET /global-manager/api/v1/global-infra/dns-forwarder-zones
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Delete the DNS Forwarder Zone
DELETE /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Read the DNS Forwarder Zone
GET /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Create or update the DNS Forwarder Zone
PATCH /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Create or update the DNS Forwarder Zone
PUT /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Delete DNS configuration for tier-0 instance
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Read the DNS Forwarder for the given tier-0 instance
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Update the DNS Forwarder
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Perform the specified DNS forwarder action
POST /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Update the DNS Forwarder
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Resolve a given address via the dns forwarder at Tier0
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/nslookup
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Get tier-0 DNS forwarder statistics
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/statistics
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Get current status of tier-0 DNS forwarder
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/status
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Delete DNS configuration for tier-1 instance
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Read the DNS Forwarder for the given tier-1 instance
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Create or update the DNS Forwarder
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Perform the specified DNS forwarder action
POST /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Create or update the DNS Forwarder
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Resolve a given address via the dns forwarder at Tier1
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/nslookup
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Get tier-1 DNS forwarder statistics
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/statistics
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Get current status of tier-1 DNS forwarder
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/status
Policy > Networking > Network Services > Forwarding Policies
List forwarding policies for the given domain
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies
Policy > Networking > Network Services > Forwarding Policies
Read forwarding policy
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Policy > Networking > Network Services > Forwarding Policies
List rules
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules
Policy > Networking > Network Services > Forwarding Policies
Read rule
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
List NAT Rules
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Delete NAT Rule
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Get NAT Rule
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Create or update a NAT Rule on tier-0
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Update NAT Rule
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
List NAT Rules
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Delete NAT Rule
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Get NAT Rule
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Create or update a Nat Rule
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Update NAT Rule
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Statistics
Get NAT Rule Statistics
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
Policy > Networking > Network Services > NAT > Statistics
List NAT Rules Statistics
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/statistics
Policy > Networking > Network Services > NAT > Statistics
Get NAT Rule Statistics
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
Policy > Networking > Network Services > NAT > Statistics
List NAT Rules Statistics
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/statistics
Policy > Networking > Networking Profiles > BFD Profiles
List BfdProfiles
GET /global-manager/api/v1/global-infra/bfd-profiles
Policy > Networking > Networking Profiles > BFD Profiles
Delete BFD Config and all the entities contained by this BfdProfile
DELETE /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > BFD Profiles
Read a BfdProfile
GET /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > BFD Profiles
Create or update a BfdProfile
PATCH /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > BFD Profiles
Create or update a BfdProfile
PUT /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > EVPN Tenant Configuration
Create or Update Evpn Tenant Configuration
PATCH /global-manager/api/v1/global-infra/evpn-tenant-configs/<config-id>
Policy > Networking > Networking Profiles > EVPN Tenant Configuration
Create or Update Evpn Tenant Configuration
PUT /global-manager/api/v1/global-infra/evpn-tenant-configs/<config-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
List all gateway QoS profiles
GET /global-manager/api/v1/global-infra/gateway-qos-profiles
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Delete gateway QoS profile
DELETE /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Read gateway QoS profile
GET /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Create or update Gateway QoS profile
PATCH /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Create or update Gateway QoS profile
PUT /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
List all IPv6 DAD profiles
GET /global-manager/api/v1/global-infra/ipv6-dad-profiles
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Delete IPv6 DAD profile
DELETE /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Read IPv6 DAD profile
GET /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Create or update IPv6 DAD profile
PATCH /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Create or update IPv6 DAD profile
PUT /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
List all IPv6 NDRA profiles
GET /global-manager/api/v1/global-infra/ipv6-ndra-profiles
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Delete IPv6 NDRA profile
DELETE /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Read IPv6 NDRA profile
GET /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Create or update IPv6 NDRA profile
PATCH /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Create or update IPv6 NDRA profile
PUT /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Operations > Compliance
Returns the compliance status
GET /global-manager/api/v1/compliance/status
Policy > Operations > Finetuning
For each type of entity what are the attributes owned by policy.
GET /global-manager/api/v1/fine-tuning/resources
Policy > Operations > IPFIX > Firewall IPFIX Collectors
List IPFIX Collector profiles.
GET /global-manager/api/v1/global-infra/ipfix-dfw-collector-profiles
Policy > Operations > IPFIX > Firewall IPFIX Collectors
Delete IPFIX dfw Collector profile
DELETE /global-manager/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Operations > IPFIX > Firewall IPFIX Collectors
Get IPFIX dfw Collector profile
GET /global-manager/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Operations > IPFIX > Firewall IPFIX Collectors
IPFIX dfw collector profile id
PATCH /global-manager/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Operations > IPFIX > Firewall IPFIX Collectors
Create or Replace IPFIX dfw collector profile
PUT /global-manager/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Operations > IPFIX > Firewall IPFIX Profiles
List IPFIX DFW Profile
GET /global-manager/api/v1/global-infra/ipfix-dfw-profiles
Policy > Operations > IPFIX > Firewall IPFIX Profiles
Delete IPFIX DFW Profile
DELETE /global-manager/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Operations > IPFIX > Firewall IPFIX Profiles
Get IPFIX DFW Profile
GET /global-manager/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Operations > IPFIX > Firewall IPFIX Profiles
Patch IPFIX DFW profile
PATCH /global-manager/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Operations > IPFIX > Firewall IPFIX Profiles
Create or Replace IPFIX DFW collection Config.
PUT /global-manager/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Collectors
List IPFIX Collector profiles.
GET /global-manager/api/v1/global-infra/ipfix-l2-collector-profiles
Policy > Operations > IPFIX > Switch IPFIX Collectors
Delete IPFIX Collector profile
DELETE /global-manager/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Collectors
Get IPFIX Collector profile
GET /global-manager/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Collectors
Patch IPFIX collector profile
PATCH /global-manager/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Collectors
Create or Replace IPFIX collector profile
PUT /global-manager/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Profiles
List IPFIX L2 Profiles
GET /global-manager/api/v1/global-infra/ipfix-l2-profiles
Policy > Operations > IPFIX > Switch IPFIX Profiles
Delete IPFIX L2 Profile
DELETE /global-manager/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Profiles
Get IPFIX L2 Profile
GET /global-manager/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Profiles
Patch IPFIX L2profile
PATCH /global-manager/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Operations > IPFIX > Switch IPFIX Profiles
Create or Replace IPFIX L2 profile
PUT /global-manager/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Operations > Port Mirroring
List Port Mirroring Profiles
GET /global-manager/api/v1/global-infra/port-mirroring-profiles
Policy > Operations > Port Mirroring
Delete Port Mirroring Profile
DELETE /global-manager/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Operations > Port Mirroring
Details of Port Mirroring Profile
GET /global-manager/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Operations > Port Mirroring
Patch Port Mirroring Profile.
PATCH /global-manager/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Operations > Port Mirroring
Create or Replace Port Mirroring Profile.
PUT /global-manager/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Security > East West Security > Distributed Firewall > Rules
List security policies
GET /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies
Policy > Security > East West Security > Distributed Firewall > Rules
Deletes a security policy from this domain
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Read security policy
GET /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Patch security policy
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Revise the positioning of security policies
POST /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>?action=revise
Policy > Security > East West Security > Distributed Firewall > Rules
Create or Update security policy
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
List rules
GET /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules
Policy > Security > East West Security > Distributed Firewall > Rules
Delete rule
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Read rule
GET /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Patch a rule
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Revise the positioning of rule
POST /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>?action=revise
Policy > Security > East West Security > Distributed Firewall > Rules
Create or update a rule
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Get PolicyFirewallSchedulers
GET /global-manager/api/v1/global-infra/firewall-schedulers
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Delete Policy Firewall Scheduler
DELETE /global-manager/api/v1/global-infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Get PolicyFirewallScheduler
GET /global-manager/api/v1/global-infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Create or Update PolicyFirewallScheduler
PATCH /global-manager/api/v1/global-infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Create or Update PolicyFirewallScheduler
PUT /global-manager/api/v1/global-infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Statistics
Get rule statistics
GET /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>/statistics
Policy > Security > East West Security > Distributed Firewall > Statistics
Get security policy statistics
GET /global-manager/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/statistics
Policy > Security > East West Security > Distributed Firewall > Statistics
Reset firewall rule statistics
POST /global-manager/api/v1/global-infra/settings/firewall/stats?action=reset
Policy > Security > North South Security > Gateway Firewall > Rules
List gateway policies
GET /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies
Policy > Security > North South Security > Gateway Firewall > Rules
Delete GatewayPolicy
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Read gateway policy
GET /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway policy
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Revise the positioning of gateway policy
POST /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>?action=revise
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway policy
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
List rules
GET /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules
Policy > Security > North South Security > Gateway Firewall > Rules
Delete rule
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Read rule
GET /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway rule
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Revise the positioning of gateway rule
POST /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>?action=revise
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway rule
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Statistics
Get gateway rule statistics
GET /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>/statistics
Policy > Security > North South Security > Gateway Firewall > Statistics
Get gateway policy statistics
GET /global-manager/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/statistics
Policy > Security > North South Security > Gateway Firewall > Tier-0 Gateways
Get list of gateway policies with rules that belong to the specific Tier-0 logical router.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/gateway-firewall
Policy > Security > North South Security > Gateway Firewall > Tier-0 Gateways
Get list of gateway policies with rules that belong to the specific Tier-0 LocalServices.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/gateway-firewall
Policy > Security > North South Security > Gateway Firewall > Tier-1 Gateways
Get list of gateway policies with rules that belong to the specific Tier-1.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/gateway-firewall
Policy > Security > North South Security > Gateway Firewall > Tier-1 Gateways
Get list of gateway policies with rules that belong to the specific Tier-1 LocalServices.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/gateway-firewall
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
List Firewall CPU Memory Thresholds Profile Binding Maps
GET /global-manager/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Delete Firewall CPU Memory Thresholds Profile Binding
DELETE /global-manager/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/<cpu-mem-thresholds-profile-binding-map-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
List all CPU and memory thresholds profiles
GET /global-manager/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Delete CPU and memory thresholds profile
DELETE /global-manager/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Read the CPU and memory thresholds profile
GET /global-manager/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Create or update CPU and memory thresholds profile
PATCH /global-manager/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Create or update CPU and memory thresholds profile
PUT /global-manager/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Get DNS security profile binding map
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps
Policy > Security > Security Profiles > DNS Security Profile Bindings
Delete DNS security profile binding map
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Get DNS security profile binding map
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Create or update DNS security profile binding map
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Update DNS security profile binding map
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profiles
List all DNS security profiles
GET /global-manager/api/v1/global-infra/dns-security-profiles
Policy > Security > Security Profiles > DNS Security Profiles
Delete DNS security profile
DELETE /global-manager/api/v1/global-infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profiles
Read the DNS Forwarder for the given tier-0 instance
GET /global-manager/api/v1/global-infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profiles
Create or update DNS security profile
PATCH /global-manager/api/v1/global-infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profiles
Create or update DNS security profile
PUT /global-manager/api/v1/global-infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
List Firewall Flood Protection Profile Binding Maps
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Firewall Flood Protection Profile Binding
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Firewall Flood Protection Profile Binding Map
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Firewall Flood Protection Profile Binding Map
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Update Firewall Flood Protection Profile Binding Map
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
List Firewall Flood Protection Profile Binding Maps for all domains
GET /global-manager/api/v1/global-infra/domains/firewall-flood-protection-profile-binding-maps
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-0 Logical Router
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-0 Logical Router
GET /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router
PUT /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-0 Logical Router LocaleServices
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
GET /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
PUT /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-1 Logical Router
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-1 Logical Router
GET /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router
PUT /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-1 Logical Router LocaleServices
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
GET /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
PUT /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profiles
List Flood Protection Profiles
GET /global-manager/api/v1/global-infra/flood-protection-profiles
Policy > Security > Security Profiles > Flood Protection Profiles
Delete Flood Protection Profile
DELETE /global-manager/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
Get Flood Protection Profile
GET /global-manager/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
Create or update Flood Protection Profile
PATCH /global-manager/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
Update Firewall Flood Protection Profile
PUT /global-manager/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
List Flood Protection Profiles
GET /global-manager/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>/bindings
Policy > Security > Security Profiles > Monitoring Profile Binding
List Group Monitoring Profile Binding Maps
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps
Policy > Security > Security Profiles > Monitoring Profile Binding
Delete Group Monitoring Profile Binding
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Monitoring Profile Binding
Get Group Monitoring Profile Binding Map
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Monitoring Profile Binding
Create Group Monitoring Profile Binding Map
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Monitoring Profile Binding
Update Group Monitoring Profile Binding Map
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-0 Logical Router LocaleServices
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
GET /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
PUT /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-0 Logical Router
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-0 Logical Router
GET /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router
PUT /global-manager/api/v1/global-infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
GET /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
PUT /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-1 Logical Router
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-1 Logical Router
GET /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router
PUT /global-manager/api/v1/global-infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
List Firewall Session Timer Profile Binding Maps
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps
Policy > Security > Security Profiles > Session Timer Profile Bindings
Delete Firewall Session Timer Profile Binding
DELETE /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
Get Firewall Session Timer Profile Binding Map
GET /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
Create or update Firewall Session Timer Profile Binding Map
PATCH /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
Update Firewall Session Timer Profile Binding Map
PUT /global-manager/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
List Firewall Session Timer Profile Binding Maps for all domains
GET /global-manager/api/v1/global-infra/domains/firewall-session-timer-profile-binding-maps
Policy > Security > Security Profiles > Session Timer Profiles
List Firewall Session Timer Profiles
GET /global-manager/api/v1/global-infra/firewall-session-timer-profiles
Policy > Security > Security Profiles > Session Timer Profiles
Delete Firewall Session Timer Profile
DELETE /global-manager/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
Get Firewall Session Timer Profile
GET /global-manager/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
Create or update Firewall Session Timer Profile
PATCH /global-manager/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
Update Firewall Session Timer Profile
PUT /global-manager/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
List Session Timer Profiles
GET /global-manager/api/v1/global-infra/session-timer-profiles/<session-timer-profile-id>/bindings
Policy > System Configuration > NSX Partial Patch
Fetch the policy partial patch configuration value.
GET /global-manager/api/v1/system-config/nsx-partial-patch-config
Policy > System Configuration > NSX Partial Patch
Saves the configuration for policy partial patch
PATCH /global-manager/api/v1/system-config/nsx-partial-patch-config
Policy > Task
Download exported file
GET /global-manager/api/v1/global-infra/settings/firewall/export?action=download
Policy > Task
Get the information of export task
GET /global-manager/api/v1/global-infra/settings/firewall/export
Policy > Task
Cancel a running export task
POST /global-manager/api/v1/global-infra/settings/firewall/export?action=cancel
Policy > Task
Invoke export task
POST /global-manager/api/v1/global-infra/settings/firewall/export
Search > Search API
DSL (Domain Specific Language) search API
GET /policy/api/v1/search/dsl (Experimental)
Search > Search API
Full text search API
GET /policy/api/v1/search/query
System Administration > Configuration > Fabric > Nodes > DNS
Read the Node's Name Servers
GET /api/v1/node/network/name-servers
GET /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers
GET /api/v1/cluster/<cluster-node-id>/node/network/name-servers
System Administration > Configuration > Fabric > Nodes > DNS
Update the Node's Name Servers
PUT /api/v1/node/network/name-servers
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers
PUT /api/v1/cluster/<cluster-node-id>/node/network/name-servers
System Administration > Configuration > Fabric > Nodes > DNS
Read the Node's Search Domains
GET /api/v1/node/network/search-domains
GET /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains
GET /api/v1/cluster/<cluster-node-id>/node/network/search-domains
System Administration > Configuration > Fabric > Nodes > DNS
Update the Node's Search Domains
PUT /api/v1/node/network/search-domains
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains
PUT /api/v1/cluster/<cluster-node-id>/node/network/search-domains
System Administration > Configuration > Fabric > Nodes > Fabric Nodes
Invoke DELETE request on target fabric node
DELETE /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
System Administration > Configuration > Fabric > Nodes > Fabric Nodes
Invoke GET request on target fabric node
GET /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
System Administration > Configuration > Fabric > Nodes > Fabric Nodes
Invoke POST request on target fabric node
POST /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
System Administration > Configuration > Fabric > Nodes > Fabric Nodes
Invoke PUT request on target fabric node
PUT /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)
System Administration > Configuration > Fabric > Nodes > File Store
List node files
GET /api/v1/node/file-store
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store
GET /api/v1/cluster/<cluster-node-id>/node/file-store
System Administration > Configuration > Fabric > Nodes > File Store
Create directory in remote file server
POST /api/v1/node/file-store?action=create_remote_directory
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store?action=create_remote_directory
POST /api/v1/cluster/<cluster-node-id>/node/file-store?action=create_remote_directory
System Administration > Configuration > Fabric > Nodes > File Store
Delete file
DELETE /api/v1/node/file-store/<file-name>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
DELETE /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
System Administration > Configuration > Fabric > Nodes > File Store
Read file properties
GET /api/v1/node/file-store/<file-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
System Administration > Configuration > Fabric > Nodes > File Store
Upload a file to the file store
POST /api/v1/node/file-store/<file-name>
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
System Administration > Configuration > Fabric > Nodes > File Store
Copy file in the file store to a remote file store
POST /api/v1/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_to_remote_file
System Administration > Configuration > Fabric > Nodes > File Store
Copy a remote file to the file store
POST /api/v1/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
System Administration > Configuration > Fabric > Nodes > File Store
Read file contents
GET /api/v1/node/file-store/<file-name>/data
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data
System Administration > Configuration > Fabric > Nodes > File Store
Replace file contents
PUT /api/v1/node/file-store/<file-name>/data
PUT /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
PUT /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data
System Administration > Configuration > Fabric > Nodes > File Store
Read file thumbprint
GET /api/v1/node/file-store/<file-name>/thumbprint
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/thumbprint
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/thumbprint
System Administration > Configuration > Fabric > Nodes > Logs
List available node logs
GET /api/v1/node/logs
GET /api/v1/transport-nodes/<transport-node-id>/node/logs
GET /api/v1/cluster/<cluster-node-id>/node/logs
System Administration > Configuration > Fabric > Nodes > Logs
Read node log properties
GET /api/v1/node/logs/<log-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name>
GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>
System Administration > Configuration > Fabric > Nodes > Logs
Read node log contents
GET /api/v1/node/logs/<log-name>/data
GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name>/data
GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>/data
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Read network configuration properties
GET /api/v1/node/network
GET /api/v1/transport-nodes/<transport-node-id>/node/network
GET /api/v1/cluster/<cluster-node-id>/node/network
System Administration > Configuration > Fabric > Nodes > Network Interfaces
List the Node's Network Interfaces
GET /api/v1/node/network/interfaces
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Read the Node's Network Interface
GET /api/v1/node/network/interfaces/<interface-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Update the Node's Network Interface
PUT /api/v1/node/network/interfaces/<interface-id>
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>
PUT /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Read the Node's Network Interface Statistics
GET /api/v1/node/network/interfaces/<interface-id>/stats
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>/stats
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>/stats
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
List node network routes
GET /api/v1/node/network/routes
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes
GET /api/v1/cluster/<cluster-node-id>/node/network/routes
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
Create node network route
POST /api/v1/node/network/routes
POST /api/v1/transport-nodes/<transport-node-id>/node/network/routes
POST /api/v1/cluster/<cluster-node-id>/node/network/routes
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
Delete node network route
DELETE /api/v1/node/network/routes/<route-id>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id>
DELETE /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
Read node network route
GET /api/v1/node/network/routes/<route-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id>
GET /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
System Administration > Configuration > Fabric > Nodes > Services
List node services
GET /api/v1/node/services
GET /api/v1/transport-nodes/<transport-node-id>/node/services
GET /api/v1/cluster/<cluster-node-id>/node/services
System Administration > Configuration > Fabric > Nodes > Services > Log Insight
Read liagent service properties
GET /api/v1/node/services/liagent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent
GET /api/v1/cluster/<cluster-node-id>/node/services/liagent
System Administration > Configuration > Fabric > Nodes > Services > Log Insight
Restart, start or stop the liagent service
POST /api/v1/node/services/liagent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/liagent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/liagent?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > Log Insight
Read liagent service status
GET /api/v1/node/services/liagent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/liagent/status
System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client
Read NSX Platform Client service properties
GET /api/v1/node/services/nsx-platform-client
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client
System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client
Restart, start or stop the NSX Platform Client service
POST /api/v1/node/services/nsx-platform-client?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client
Read NSX Platform Client service status
GET /api/v1/node/services/nsx-platform-client/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client/status
System Administration > Configuration > Fabric > Nodes > Services > NTP
Read NTP service properties
GET /api/v1/node/services/ntp
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp
GET /api/v1/cluster/<cluster-node-id>/node/services/ntp
System Administration > Configuration > Fabric > Nodes > Services > NTP
Restart, start or stop the NTP service
POST /api/v1/node/services/ntp?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ntp?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/ntp?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > NTP
Update NTP service properties
PUT /api/v1/node/services/ntp
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ntp
PUT /api/v1/cluster/<cluster-node-id>/node/services/ntp
System Administration > Configuration > Fabric > Nodes > Services > NTP
Read NTP service status
GET /api/v1/node/services/ntp/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ntp/status
System Administration > Configuration > Fabric > Nodes > Services > Node Management
Read appliance management service properties
GET /api/v1/node/services/node-mgmt
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt
GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt
System Administration > Configuration > Fabric > Nodes > Services > Node Management
Restart the node management service
POST /api/v1/node/services/node-mgmt?action=restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt?action=restart
POST /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt?action=restart
System Administration > Configuration > Fabric > Nodes > Services > Node Management
Read appliance management service status
GET /api/v1/node/services/node-mgmt/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt/status
GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt/status
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Read SNMP service properties
GET /api/v1/node/services/snmp
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Restart, start or stop the SNMP service
POST /api/v1/node/services/snmp?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/snmp?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/snmp?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Update SNMP service properties
PUT /api/v1/node/services/snmp
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp
PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Read SNMP service status
GET /api/v1/node/services/snmp/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/status
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/status
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Read SNMP V3 Engine ID
GET /api/v1/node/services/snmp/v3-engine-id
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Update SNMP V3 Engine ID
PUT /api/v1/node/services/snmp/v3-engine-id
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id
PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
System Administration > Configuration > Fabric > Nodes > Services > SSH
Read ssh service properties
GET /api/v1/node/services/ssh
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh
System Administration > Configuration > Fabric > Nodes > Services > SSH
Restart, start or stop the ssh service
POST /api/v1/node/services/ssh?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > Services > SSH
Remove a host's fingerprint from known hosts file
POST /api/v1/node/services/ssh?action=remove_host_fingerprint
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=remove_host_fingerprint
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=remove_host_fingerprint
System Administration > Configuration > Fabric > Nodes > Services > SSH
Update ssh service properties
PUT /api/v1/node/services/ssh
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ssh
PUT /api/v1/cluster/<cluster-node-id>/node/services/ssh
System Administration > Configuration > Fabric > Nodes > Services > SSH
Restart, start or stop the ssh service
POST /api/v1/node/services/ssh/notify_mpa?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/notify_mpa?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh/notify_mpa?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > Services > SSH
Read ssh service status
GET /api/v1/node/services/ssh/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh/status
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Read syslog service properties
GET /api/v1/node/services/syslog
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Restart, start or stop the syslog service
POST /api/v1/node/services/syslog?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Delete all node syslog exporters
DELETE /api/v1/node/services/syslog/exporters
DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
System Administration > Configuration > Fabric > Nodes > Services > Syslog
List node syslog exporters
GET /api/v1/node/services/syslog/exporters
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Add node syslog exporter
POST /api/v1/node/services/syslog/exporters
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Verify node syslog exporter
POST /api/v1/node/services/syslog/exporters?action=verify
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters?action=verify
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters?action=verify
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Delete node syslog exporter
DELETE /api/v1/node/services/syslog/exporters/<exporter-name>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name>
DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Read node syslog exporter
GET /api/v1/node/services/syslog/exporters/<exporter-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name>
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Read syslog service status
GET /api/v1/node/services/syslog/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/status
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/status
System Administration > Configuration > Fabric > Nodes > Services > Tasks
List appliance management tasks
GET /api/v1/node/tasks
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks
GET /api/v1/cluster/<cluster-node-id>/node/tasks
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Delete task
DELETE /api/v1/node/tasks/<task-id>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>
DELETE /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Read task properties
GET /api/v1/node/tasks/<task-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>
GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Cancel specified task
POST /api/v1/node/tasks/<task-id>?action=cancel
POST /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>?action=cancel
POST /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>?action=cancel
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Read asynchronous task response
GET /api/v1/node/tasks/<task-id>/response
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>/response
GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>/response
System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent
Read NSX upgrade Agent service properties
GET /api/v1/node/services/nsx-upgrade-agent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent
System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent
Restart, start or stop the NSX upgrade agent service
POST /api/v1/node/services/nsx-upgrade-agent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent
Read Nsx upgrade agent service status
GET /api/v1/node/services/nsx-upgrade-agent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent/status
System Administration > Configuration > Fabric > Nodes > Settings
Read node properties
GET /api/v1/node
GET /api/v1/transport-nodes/<transport-node-id>/node
GET /api/v1/cluster/<cluster-node-id>/node
System Administration > Configuration > Fabric > Nodes > Settings
Set the node system time
POST /api/v1/node?action=set_system_time
POST /api/v1/transport-nodes/<transport-node-id>/node?action=set_system_time
POST /api/v1/cluster/<cluster-node-id>/node?action=set_system_time
System Administration > Configuration > Fabric > Nodes > Settings
Restart or shutdown node
POST /api/v1/node?action=restart|shutdown
POST /api/v1/transport-nodes/<transport-node-id>/node?action=restart|shutdown
POST /api/v1/cluster/<cluster-node-id>/node?action=restart|shutdown
System Administration > Configuration > Fabric > Nodes > Settings
Update node properties
PUT /api/v1/node
PUT /api/v1/transport-nodes/<transport-node-id>/node
PUT /api/v1/cluster/<cluster-node-id>/node
System Administration > Configuration > Fabric > Nodes > Settings
List node processes
GET /api/v1/node/processes
GET /api/v1/transport-nodes/<transport-node-id>/node/processes
GET /api/v1/cluster/<cluster-node-id>/node/processes
System Administration > Configuration > Fabric > Nodes > Settings
Read node process
GET /api/v1/node/processes/<process-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/processes/<process-id>
GET /api/v1/cluster/<cluster-node-id>/node/processes/<process-id>
System Administration > Configuration > Fabric > Nodes > Settings
Read node status
GET /api/v1/node/status
GET /api/v1/transport-nodes/<transport-node-id>/node/status
GET /api/v1/cluster/<cluster-node-id>/node/status
System Administration > Configuration > Fabric > Nodes > Settings
Update node status
POST /api/v1/node/status?action=clear_bootup_error
POST /api/v1/transport-nodes/<transport-node-id>/node/status?action=clear_bootup_error
POST /api/v1/cluster/<cluster-node-id>/node/status?action=clear_bootup_error
System Administration > Configuration > Fabric > Nodes > Settings
Read node version
GET /api/v1/node/version
GET /api/v1/transport-nodes/<transport-node-id>/node/version
GET /api/v1/cluster/<cluster-node-id>/node/version
System Administration > Configuration > Fabric > Nodes > Support-Bundle
Read node support bundle
GET /api/v1/node/support-bundle
GET /api/v1/transport-nodes/<transport-node-id>/node/support-bundle
GET /api/v1/cluster/<cluster-node-id>/node/support-bundle
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke DELETE request on target transport node
DELETE /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke GET request on target transport node
GET /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke POST request on target transport node
POST /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke PUT request on target transport node
PUT /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > User Management > Authentication Policy
Read node authentication policy configuration
GET /api/v1/node/aaa/auth-policy
GET /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy
GET /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy
System Administration > Configuration > Fabric > Nodes > User Management > Authentication Policy
Update node authentication policy configuration
PUT /api/v1/node/aaa/auth-policy
PUT /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy
PUT /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy
System Administration > Configuration > Fabric > Nodes > User Management > Users
List node users
GET /api/v1/node/users
GET /api/v1/transport-nodes/<transport-node-id>/node/users
GET /api/v1/cluster/<cluster-node-id>/node/users
System Administration > Configuration > Fabric > Nodes > User Management > Users
Reset a user's own password. Requires current password
POST /api/v1/node/users?action=reset_own_password
POST /api/v1/transport-nodes/<transport-node-id>/node/users?action=reset_own_password
POST /api/v1/cluster/<cluster-node-id>/node/users?action=reset_own_password
System Administration > Configuration > Fabric > Nodes > User Management > Users
Read node user
GET /api/v1/node/users/<userid>
GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>
GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>
System Administration > Configuration > Fabric > Nodes > User Management > Users
Reset a user's password without requiring their current password
POST /api/v1/node/users/<userid>?action=reset_password
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>?action=reset_password
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>?action=reset_password
System Administration > Configuration > Fabric > Nodes > User Management > Users
Update node user
PUT /api/v1/node/users/<userid>
PUT /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>
PUT /api/v1/cluster/<cluster-node-id>/node/users/<userid>
System Administration > Configuration > Fabric > Nodes > User Management > Users
List SSH keys from authorized_keys file for node user
GET /api/v1/node/users/<userid>/ssh-keys
GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys
GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys
System Administration > Configuration > Fabric > Nodes > User Management > Users
Remove SSH public key from authorized_keys file for node user
POST /api/v1/node/users/<userid>/ssh-keys?action=remove_ssh_key
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key
System Administration > Configuration > Fabric > Nodes > User Management > Users
Add SSH public key to authorized_keys file for node user
POST /api/v1/node/users/<userid>/ssh-keys?action=add_ssh_key
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key
System Administration > Configuration > NSX Intelligence > Appliance Management
Update the async_replicator service properties
PUT /api/v1/node/services/async_replicator
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator
PUT /api/v1/cluster/<cluster-node-id>/node/services/async_replicator
System Administration > Configuration > NSX Managers > API Services > API Request Batching
Register a Collection of API Calls at a Single End Point
POST /policy/api/v1/batch
System Administration > Configuration > NSX Managers > API Services > Configuration
Read API service properties
GET /api/v1/cluster/api-service
System Administration > Configuration > NSX Managers > API Services > Configuration
Update API service properties
PUT /api/v1/cluster/api-service
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
Read cluster certificate ID
GET /api/v1/cluster/api-certificate
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
Clear the cluster certificate
POST /api/v1/cluster/api-certificate?action=clear_cluster_certificate (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
Set the cluster certificate
POST /api/v1/cluster/api-certificate?action=set_cluster_certificate
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Join this node to a NSX Cluster
POST /api/v1/cluster?action=join_cluster
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Detach a node from the Cluster
POST /api/v1/cluster/<node-id>?action=remove_node
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke DELETE request on target cluster node
DELETE /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke GET request on target cluster node
GET /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke POST request on target cluster node
POST /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke PUT request on target cluster node
PUT /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Get backup frames for UI
GET /api/v1/cluster/backups/ui_frames
System Administration > Configuration > NSX Managers > Clusters > Cluster Virtual IP
Read cluster virtual IP address
GET /api/v1/cluster/api-virtual-ip
System Administration > Configuration > NSX Managers > Clusters > Cluster Virtual IP
Set cluster virtual IP address
POST /api/v1/cluster/api-virtual-ip?action=set_virtual_ip
System Administration > Configuration > NSX Managers > Clusters > Cluster Virtual IP
Clear cluster virtual IP address
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip
System Administration > Configuration > NSX Managers > Hardening > Mandatory Access Control
Gets the enable status for Mandatory Access Control
GET /api/v1/node/hardening-policy/mandatory-access-control
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control
System Administration > Configuration > NSX Managers > Hardening > Mandatory Access Control
Enable or disable Mandatory Access Control
PUT /api/v1/node/hardening-policy/mandatory-access-control
PUT /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
PUT /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control
System Administration > Configuration > NSX Managers > Hardening > Mandatory Access Control
Get the report for Mandatory Access Control
GET /api/v1/node/hardening-policy/mandatory-access-control/report
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control/report
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control/report
System Administration > Configuration > NSX Managers > Manager Configuration
Read NSX Management nodes global configuration.
GET /policy/api/v1/configs/management
System Administration > Configuration > NSX Managers > Manager Configuration
Update NSX Management nodes global configuration
PUT /policy/api/v1/configs/management
System Administration > Configuration > NSX Managers > Nodes > Manager Configuration
Read Central Config properties
GET /api/v1/node/central-config
GET /api/v1/transport-nodes/<transport-node-id>/node/central-config
GET /api/v1/cluster/<cluster-node-id>/node/central-config
System Administration > Configuration > NSX Managers > Nodes > Manager Configuration
Update Central Config properties
PUT /api/v1/node/central-config
PUT /api/v1/transport-nodes/<transport-node-id>/node/central-config
PUT /api/v1/cluster/<cluster-node-id>/node/central-config
System Administration > Configuration > NSX Managers > Nodes > Manager Rabbitmq Configuration
Delete RabbitMQ management port
DELETE /api/v1/node/rabbitmq-management-port
DELETE /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
DELETE /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port
System Administration > Configuration > NSX Managers > Nodes > Manager Rabbitmq Configuration
Check if RabbitMQ management port is enabled or not
GET /api/v1/node/rabbitmq-management-port
GET /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
GET /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port
System Administration > Configuration > NSX Managers > Nodes > Manager Rabbitmq Configuration
Set RabbitMQ management port
POST /api/v1/node/rabbitmq-management-port
POST /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
POST /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port
System Administration > Configuration > NSX Managers > Nodes > Services > Async Replicator Service
Read the Async Replicator service properties
GET /api/v1/node/services/async_replicator
GET /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator
System Administration > Configuration > NSX Managers > Nodes > Services > Async Replicator Service
Restart, start or stop the Async Replicator service
POST /api/v1/node/services/async_replicator?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/async_replicator?action=restart|start|stop
System Administration > Configuration > NSX Managers > Nodes > Services > Async Replicator Service
Read the Async Replicator service status
GET /api/v1/node/services/async_replicator/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator/status
System Administration > Configuration > NSX Managers > Nodes > Services > Cluster Manager Service
Read cluster boot manager service properties
GET /api/v1/node/services/cluster_manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager
System Administration > Configuration > NSX Managers > Nodes > Services > Cluster Manager Service
Restart, start or stop the cluster boot manager service
POST /api/v1/node/services/cluster_manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager?action=start|stop|restart
System Administration > Configuration > NSX Managers > Nodes > Services > Cluster Manager Service
Read cluster boot manager service status
GET /api/v1/node/services/cluster_manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager/status
System Administration > Configuration > NSX Managers > Nodes > Services > Global Manager Service
Read service properties
GET /api/v1/node/services/global-manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager
GET /api/v1/cluster/<cluster-node-id>/node/services/global-manager
System Administration > Configuration > NSX Managers > Nodes > Services > Global Manager Service
Disable Global Manager service
POST /api/v1/node/services/global-manager?action=disable
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=disable
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=disable
System Administration > Configuration > NSX Managers > Nodes > Services > Global Manager Service
Enable Global Manager service
POST /api/v1/node/services/global-manager?action=enable
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=enable
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=enable
System Administration > Configuration > NSX Managers > Nodes > Services > Global Manager Service
Restart, start or stop the service
POST /api/v1/node/services/global-manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=start|stop|restart
System Administration > Configuration > NSX Managers > Nodes > Services > Global Manager Service
Reset the logging levels to default values
POST /api/v1/node/services/global-manager?action=reset-manager-logging-levels
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=reset-manager-logging-levels
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=reset-manager-logging-levels
System Administration > Configuration > NSX Managers > Nodes > Services > Global Manager Service
Update service properties
PUT /api/v1/node/services/global-manager
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager
PUT /api/v1/cluster/<cluster-node-id>/node/services/global-manager
System Administration > Configuration > NSX Managers > Nodes > Services > Global Manager Service
Read service status
GET /api/v1/node/services/global-manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/global-manager/status
System Administration > Configuration > NSX Managers > Nodes > Services > HTTP Service
Read http service properties
GET /api/v1/node/services/http (Deprecated)
GET /api/v1/transport-nodes/<transport-node-id>/node/services/http (Deprecated)
GET /api/v1/cluster/<cluster-node-id>/node/services/http (Deprecated)
System Administration > Configuration > NSX Managers > Nodes > Services > HTTP Service
Start the http service
POST /api/v1/node/services/http?action=start
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=start
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=start
System Administration > Configuration > NSX Managers > Nodes > Services > HTTP Service
Update http service certificate
POST /api/v1/node/services/http?action=apply_certificate
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=apply_certificate
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=apply_certificate
System Administration > Configuration > NSX Managers > Nodes > Services > HTTP Service
Restart the http service
POST /api/v1/node/services/http?action=restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=restart
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=restart
System Administration > Configuration > NSX Managers > Nodes > Services > HTTP Service
Stop the http service
POST /api/v1/node/services/http?action=stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=stop
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=stop
System Administration > Configuration > NSX Managers > Nodes > Services > HTTP Service
Update http service properties
PUT /api/v1/node/services/http (Deprecated)
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/http (Deprecated)
PUT /api/v1/cluster/<cluster-node-id>/node/services/http (Deprecated)
System Administration > Configuration > NSX Managers > Nodes > Services > HTTP Service
Read http service status
GET /api/v1/node/services/http/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/http/status
GET /api/v1/cluster/<cluster-node-id>/node/services/http/status
System Administration > Configuration > NSX Managers > Nodes > Services > Install Upgrade Service
Read NSX install-upgrade service properties
GET /api/v1/node/services/install-upgrade
GET /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade
System Administration > Configuration > NSX Managers > Nodes > Services > Install Upgrade Service
Restart, start or stop the NSX install-upgrade service
POST /api/v1/node/services/install-upgrade?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade?action=restart|start|stop
System Administration > Configuration > NSX Managers > Nodes > Services > Install Upgrade Service
Update NSX install-upgrade service properties
PUT /api/v1/node/services/install-upgrade
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade
System Administration > Configuration > NSX Managers > Nodes > Services > Install Upgrade Service
Read NSX install-upgrade service status
GET /api/v1/node/services/install-upgrade/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade/status
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/status
System Administration > Configuration > NSX Managers > Nodes > Services > Install Upgrade Service
Update UC state properties
PUT /api/v1/node/services/install-upgrade/uc-state
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade/uc-state
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/uc-state
System Administration > Configuration > NSX Managers > Nodes > Services > Management Plane Bus Service
Read Rabbit MQ service properties
GET /api/v1/node/services/mgmt-plane-bus
GET /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus
GET /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus
System Administration > Configuration > NSX Managers > Nodes > Services > Management Plane Bus Service
Restart, start or stop the Rabbit MQ service
POST /api/v1/node/services/mgmt-plane-bus?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus?action=restart|start|stop
System Administration > Configuration > NSX Managers > Nodes > Services > Management Plane Bus Service
Read Rabbit MQ service status
GET /api/v1/node/services/mgmt-plane-bus/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus/status
GET /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus/status
System Administration > Configuration > NSX Managers > Nodes > Services > Manager Service
Read service properties
GET /api/v1/node/services/manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/manager
GET /api/v1/cluster/<cluster-node-id>/node/services/manager
System Administration > Configuration > NSX Managers > Nodes > Services > Manager Service
Reset the logging levels to default values
POST /api/v1/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/transport-nodes/<transport-node-id>/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=reset-manager-logging-levels
System Administration > Configuration > NSX Managers > Nodes > Services > Manager Service
Restart, start or stop the service
POST /api/v1/node/services/manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=start|stop|restart
System Administration > Configuration > NSX Managers > Nodes > Services > Manager Service
Update service properties
PUT /api/v1/node/services/manager
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/manager
PUT /api/v1/cluster/<cluster-node-id>/node/services/manager
System Administration > Configuration > NSX Managers > Nodes > Services > Manager Service
Read service status
GET /api/v1/node/services/manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/manager/status
System Administration > Configuration > NSX Managers > Nodes > Services > NSX Message Service
Read NSX Message Bus service properties
GET /api/v1/node/services/nsx-message-bus
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus
System Administration > Configuration > NSX Managers > Nodes > Services > NSX Message Service
Restart, start or stop the NSX Message Bus service
POST /api/v1/node/services/nsx-message-bus?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus?action=restart|start|stop
System Administration > Configuration > NSX Managers > Nodes > Services > NSX Message Service
Read NSX Message Bus service status
GET /api/v1/node/services/nsx-message-bus/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus/status
System Administration > Configuration > NSX Managers > Nodes > Services > Search Service
Read NSX Search service properties
GET /api/v1/node/services/search
GET /api/v1/transport-nodes/<transport-node-id>/node/services/search
GET /api/v1/cluster/<cluster-node-id>/node/services/search
System Administration > Configuration > NSX Managers > Nodes > Services > Search Service
Restart, start or stop the NSX Search service
POST /api/v1/node/services/search?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/search?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/search?action=restart|start|stop
System Administration > Configuration > NSX Managers > Nodes > Services > Search Service
Read NSX Search service status
GET /api/v1/node/services/search/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/search/status
GET /api/v1/cluster/<cluster-node-id>/node/services/search/status
System Administration > Configuration > NSX Managers > Nodes > Services > Telemetry Service
Read Telemetry service properties
GET /api/v1/node/services/telemetry
GET /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry
System Administration > Configuration > NSX Managers > Nodes > Services > Telemetry Service
Restart, start or stop Telemetry service
POST /api/v1/node/services/telemetry?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/telemetry?action=restart|start|stop
System Administration > Configuration > NSX Managers > Nodes > Services > Telemetry Service
Read Telemetry service status
GET /api/v1/node/services/telemetry/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry/status
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry/status
System Administration > Configuration > NSX Managers > Nodes > Services > User Interface Service
Read ui service properties
GET /api/v1/node/services/ui-service
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service
System Administration > Configuration > NSX Managers > Nodes > Services > User Interface Service
Restart, Start and Stop the ui service
POST /api/v1/node/services/ui-service?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/ui-service?action=restart|start|stop
System Administration > Configuration > NSX Managers > Nodes > Services > User Interface Service
Read ui service status
GET /api/v1/node/services/ui-service/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service/status
System Administration > Lifecycle Management > Backup Restore Management > Backup
Request one-time backup
POST /policy/api/v1/cluster?action=backup_to_remote
System Administration > Lifecycle Management > Backup Restore Management > Backup
Request one-time inventory summary.
POST /policy/api/v1/cluster?action=summarize_inventory_to_remote
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get ssh fingerprint of remote(backup) server
POST /policy/api/v1/cluster/backups?action=retrieve_ssh_fingerprint
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get backup configuration
GET /policy/api/v1/cluster/backups/config
System Administration > Lifecycle Management > Backup Restore Management > Backup
Configure backup
PUT /policy/api/v1/cluster/backups/config
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get backup history
GET /policy/api/v1/cluster/backups/history
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get all backup related information for a site
GET /policy/api/v1/cluster/backups/overview
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get backup status
GET /policy/api/v1/cluster/backups/status
System Administration > Lifecycle Management > Backup Restore Management > Restore
Cancel any running restore operation
POST /policy/api/v1/cluster/restore?action=cancel
System Administration > Lifecycle Management > Backup Restore Management > Restore
Suspend any running restore operation
POST /policy/api/v1/cluster/restore?action=suspend
System Administration > Lifecycle Management > Backup Restore Management > Restore
Initiate a restore operation
POST /policy/api/v1/cluster/restore?action=start
System Administration > Lifecycle Management > Backup Restore Management > Restore
Advance any suspended restore operation
POST /policy/api/v1/cluster/restore?action=advance
System Administration > Lifecycle Management > Backup Restore Management > Restore
Retry any failed restore operation
POST /policy/api/v1/cluster/restore?action=retry
System Administration > Lifecycle Management > Backup Restore Management > Restore
List timestamps of all available Cluster Backups.
GET /policy/api/v1/cluster/restore/backuptimestamps
System Administration > Lifecycle Management > Backup Restore Management > Restore
List resources for a given instruction, to be shown to/executed by users.
GET /policy/api/v1/cluster/restore/instruction-resources
System Administration > Lifecycle Management > Backup Restore Management > Restore
Query Restore Request Status
GET /api/v1/cluster/restore/status
System Administration > Lifecycle Management > Upgrade > Bundles
Upgrade the upgrade coordinator.
POST /api/v1/upgrade?action=upgrade_uc
System Administration > Lifecycle Management > Upgrade > Bundles
Upload upgrade bundle
POST /api/v1/upgrade/bundle?action=upload (Deprecated)
System Administration > Lifecycle Management > Upgrade > Bundles
Upload upgrade bundle
POST /api/v1/upgrade/bundles?action=upload
System Administration > Lifecycle Management > Upgrade > Bundles
Fetch upgrade bundle from given url
POST /api/v1/upgrade/bundles
System Administration > Lifecycle Management > Upgrade > Bundles
Get uploaded upgrade bundle information
GET /api/v1/upgrade/bundles/<bundle-id>
System Administration > Lifecycle Management > Upgrade > Bundles
Cancel upgrade bundle upload
POST /api/v1/upgrade/bundles/<bundle-id>?action=cancel_upload
System Administration > Lifecycle Management > Upgrade > Bundles
Get uploaded upgrade bundle upload status
GET /api/v1/upgrade/bundles/<bundle-id>/upload-status
System Administration > Lifecycle Management > Upgrade > Eula
Accept end user license agreement
POST /api/v1/upgrade/eula/accept
System Administration > Lifecycle Management > Upgrade > Eula
Return the acceptance status of end user license agreement
GET /api/v1/upgrade/eula/acceptance
System Administration > Lifecycle Management > Upgrade > Eula
Return the content of end user license agreement
GET /api/v1/upgrade/eula/content
System Administration > Lifecycle Management > Upgrade > Group
Return information of all upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups
System Administration > Lifecycle Management > Upgrade > Group
Create a group
POST /api/v1/upgrade/upgrade-unit-groups
System Administration > Lifecycle Management > Upgrade > Group
Get upgrade status for upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups-status
System Administration > Lifecycle Management > Upgrade > Group
Delete the upgrade unit group
DELETE /api/v1/upgrade/upgrade-unit-groups/<group-id>
System Administration > Lifecycle Management > Upgrade > Group
Return upgrade unit group information
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>
System Administration > Lifecycle Management > Upgrade > Group
Add upgrade units to specified upgrade unit group
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=add_upgrade_units
System Administration > Lifecycle Management > Upgrade > Group
Reorder upgrade unit group
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=reorder
System Administration > Lifecycle Management > Upgrade > Group
Update the upgrade unit group
PUT /api/v1/upgrade/upgrade-unit-groups/<group-id>
System Administration > Lifecycle Management > Upgrade > Group
Get upgrade status for group
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>/status
System Administration > Lifecycle Management > Upgrade > Group
Reorder an upgrade unit within the upgrade unit group
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>/upgrade-unit/<upgrade-unit-id>?action=reorder
System Administration > Lifecycle Management > Upgrade > Group
Return aggregate information of all upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups/aggregate-info
System Administration > Lifecycle Management > Upgrade > History
Get upgrade history
GET /api/v1/upgrade/history
System Administration > Lifecycle Management > Upgrade > Nodes
Get upgrade task status
GET /api/v1/node/upgrade
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade
GET /api/v1/cluster/<cluster-node-id>/node/upgrade
System Administration > Lifecycle Management > Upgrade > Nodes
Execute upgrade task
POST /api/v1/node/upgrade/performtask?action=[^/]+
POST /api/v1/transport-nodes/<transport-node-id>/node/upgrade/performtask?action=[^/]+
POST /api/v1/cluster/<cluster-node-id>/node/upgrade/performtask?action=[^/]+
System Administration > Lifecycle Management > Upgrade > Nodes
Get upgrade progress status
GET /api/v1/node/upgrade/progress-status
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade/progress-status
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/progress-status
System Administration > Lifecycle Management > Upgrade > Nodes
Get upgrade status summary
GET /api/v1/node/upgrade/status-summary
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade/status-summary
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/status-summary
System Administration > Lifecycle Management > Upgrade > Nodes
Get list of nodes across all types
GET /api/v1/upgrade/nodes
System Administration > Lifecycle Management > Upgrade > Nodes
Get summary of nodes
GET /api/v1/upgrade/nodes-summary
System Administration > Lifecycle Management > Upgrade > Nodes
Get the version whitelist
GET /policy/api/v1/upgrade/version-whitelist
System Administration > Lifecycle Management > Upgrade > Nodes
Get the version whitelist for the specified component
GET /policy/api/v1/upgrade/version-whitelist/<component_type>
System Administration > Lifecycle Management > Upgrade > Nodes
Update the version whitelist for the specified component type
PUT /policy/api/v1/upgrade/version-whitelist/<component_type>
System Administration > Lifecycle Management > Upgrade > Plan
Execute pre-upgrade checks
POST /api/v1/upgrade?action=execute_pre_upgrade_checks
System Administration > Lifecycle Management > Upgrade > Plan
Abort pre-upgrade checks
POST /api/v1/upgrade?action=abort_pre_upgrade_checks
System Administration > Lifecycle Management > Upgrade > Plan
Execute post-upgrade checks
POST /api/v1/upgrade/<component-type>?action=execute_post_upgrade_checks
System Administration > Lifecycle Management > Upgrade > Plan
Reset upgrade plan to default plan
POST /api/v1/upgrade/plan?action=reset
System Administration > Lifecycle Management > Upgrade > Plan
Upgrade selected units
POST /api/v1/upgrade/plan?action=upgrade_selected_units
System Administration > Lifecycle Management > Upgrade > Plan
Stage the upgrade bits
POST /api/v1/upgrade/plan?action=stage-upgrade
System Administration > Lifecycle Management > Upgrade > Plan
Start upgrade
POST /api/v1/upgrade/plan?action=start
System Administration > Lifecycle Management > Upgrade > Plan
Pause upgrade
POST /api/v1/upgrade/plan?action=pause
System Administration > Lifecycle Management > Upgrade > Plan
Continue upgrade
POST /api/v1/upgrade/plan?action=continue
System Administration > Lifecycle Management > Upgrade > Plan
Get upgrade plan settings for the component
GET /api/v1/upgrade/plan/<component_type>/settings
System Administration > Lifecycle Management > Upgrade > Plan
Update upgrade plan settings for the component
PUT /api/v1/upgrade/plan/<component_type>/settings
System Administration > Lifecycle Management > Upgrade > Plan
Returns pre-upgrade checks in csv format
GET /api/v1/upgrade/pre-upgrade-checks?format=csv
System Administration > Lifecycle Management > Upgrade > Plan
Get Pre-upgrade Check Failures
GET /api/v1/upgrade/pre-upgrade-checks/failures
System Administration > Lifecycle Management > Upgrade > Plan
Returns information about upgrade checks
GET /api/v1/upgrade/upgrade-checks-info
System Administration > Lifecycle Management > Upgrade > Status
Get functional state of the upgrade coordinator
GET /api/v1/upgrade/functional-state
System Administration > Lifecycle Management > Upgrade > Status
Get upgrade status summary
GET /api/v1/upgrade/status-summary
System Administration > Lifecycle Management > Upgrade > Status
Get upgrade summary
GET /api/v1/upgrade/summary
System Administration > Lifecycle Management > Upgrade > Status
Get upgrade-coordinator upgrade status
GET /api/v1/upgrade/uc-upgrade-status
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get upgrade units
GET /api/v1/upgrade/upgrade-units
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get upgrade units stats
GET /api/v1/upgrade/upgrade-units-stats
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get a specific upgrade unit
GET /api/v1/upgrade/upgrade-units/<upgrade-unit-id>
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get upgrade units aggregate-info
GET /api/v1/upgrade/upgrade-units/aggregate-info
System Administration > Monitoring > Dashboards > UI Views
Returns the Views based on query criteria defined in ViewQueryParameters.
GET /global-manager/api/v1/ui-views
System Administration > Monitoring > Dashboards > UI Views
Creates a new View.
POST /global-manager/api/v1/ui-views
System Administration > Monitoring > Dashboards > UI Views
Delete View
DELETE /global-manager/api/v1/ui-views/<view-id>
System Administration > Monitoring > Dashboards > UI Views
Returns View Information
GET /global-manager/api/v1/ui-views/<view-id>
System Administration > Monitoring > Dashboards > UI Views
Update View
PUT /global-manager/api/v1/ui-views/<view-id>
System Administration > Monitoring > Dashboards > Widget Configuration
Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.
GET /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations
System Administration > Monitoring > Dashboards > Widget Configuration
Creates a new Widget Configuration.
POST /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations
System Administration > Monitoring > Dashboards > Widget Configuration
Delete Widget Configuration
DELETE /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
System Administration > Monitoring > Dashboards > Widget Configuration
Returns Widget Configuration Information
GET /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
System Administration > Monitoring > Dashboards > Widget Configuration
Update Widget Configuration
PUT /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
System Administration > Monitoring > Error Resolver
Fetches a list of metadata for all the registered error resolvers
GET /policy/api/v1/error-resolver
System Administration > Monitoring > Error Resolver
Resolves the error
POST /policy/api/v1/error-resolver?action=resolve_error
System Administration > Monitoring > Error Resolver
Fetches metadata about the given error_id
GET /policy/api/v1/error-resolver/<error_id>
System Administration > Monitoring > Logs > Core Dumps
List system core dumps
GET /api/v1/node/core-dumps
GET /api/v1/transport-nodes/<transport-node-id>/node/core-dumps
GET /api/v1/cluster/<cluster-node-id>/node/core-dumps
System Administration > Monitoring > Logs > Core Dumps
Copy system generated core dump file to a remote file store
POST /api/v1/node/core-dumps/<file-name>?action=copy_to_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/core-dumps/<file-name>?action=copy_to_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/core-dumps/<file-name>?action=copy_to_remote_file
System Administration > Settings > Licenses
Accept end user license agreement
POST /policy/api/v1/eula/accept
System Administration > Settings > Licenses
Return the acceptance status of end user license agreement
GET /policy/api/v1/eula/acceptance
System Administration > Settings > Licenses
Return the content of end user license agreement
GET /policy/api/v1/eula/content
System Administration > Settings > Support Bundle
Delete existing support bundles waiting to be downloaded
POST /api/v1/administration/support-bundles?action=delete_async_response
System Administration > Settings > Support Bundle
Collect support bundles from registered cluster and fabric nodes
POST /api/v1/administration/support-bundles?action=collect
System Administration > Settings > User Management > Access Token
Create registration access token
POST /policy/api/v1/aaa/registration-token
System Administration > Settings > User Management > Access Token
Delete registration access token
DELETE /policy/api/v1/aaa/registration-token/<token>
System Administration > Settings > User Management > Access Token
Get registration access token
GET /policy/api/v1/aaa/registration-token/<token>
System Administration > Settings > User Management > LDAP Identity Sources
List LDAP identity sources
GET /global-manager/api/v1/aaa/ldap-identity-sources
System Administration > Settings > User Management > LDAP Identity Sources
Probe an LDAP identity source
POST /global-manager/api/v1/aaa/ldap-identity-sources?action=probe_identity_source
System Administration > Settings > User Management > LDAP Identity Sources
Fetch the server certificate of an LDAP server
POST /global-manager/api/v1/aaa/ldap-identity-sources?action=fetch_certificate
System Administration > Settings > User Management > LDAP Identity Sources
Test an LDAP server
POST /global-manager/api/v1/aaa/ldap-identity-sources?action=probe_ldap_server
System Administration > Settings > User Management > LDAP Identity Sources
Delete an LDAP identity source
DELETE /global-manager/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>
System Administration > Settings > User Management > LDAP Identity Sources
Read a single LDAP identity source
GET /global-manager/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>
System Administration > Settings > User Management > LDAP Identity Sources
Test the configuration of an existing LDAP identity source
POST /global-manager/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>?action=probe
System Administration > Settings > User Management > LDAP Identity Sources
Update an existing LDAP identity source
PUT /global-manager/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>
System Administration > Settings > User Management > LDAP Identity Sources
Search the LDAP identity source
POST /global-manager/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>/search
System Administration > Settings > User Management > Roles
List feature permissions
GET /policy/api/v1/aaa/features-with-properties
System Administration > Settings > User Management > Roles
Get all users and groups with their roles
GET /policy/api/v1/aaa/role-bindings
System Administration > Settings > User Management > Roles
Delete all stale role assignments
POST /policy/api/v1/aaa/role-bindings?action=delete_stale_bindings
System Administration > Settings > User Management > Roles
Assign roles to User or Group
POST /policy/api/v1/aaa/role-bindings
System Administration > Settings > User Management > Roles
Delete user/group's roles assignment
DELETE /policy/api/v1/aaa/role-bindings/<binding-id>
System Administration > Settings > User Management > Roles
Get user/group's role information
GET /policy/api/v1/aaa/role-bindings/<binding-id>
System Administration > Settings > User Management > Roles
Update User or Group's roles
PUT /policy/api/v1/aaa/role-bindings/<binding-id>
System Administration > Settings > User Management > Roles
Get information about all roles
GET /policy/api/v1/aaa/roles
System Administration > Settings > User Management > Roles
Validate a new feature permission set
POST /policy/api/v1/aaa/roles?action=validate
System Administration > Settings > User Management > Roles
Get information about all roles with features and their permissions
GET /policy/api/v1/aaa/roles-with-feature-permissions
System Administration > Settings > User Management > Roles
Delete custom role
DELETE /policy/api/v1/aaa/roles/<role>
System Administration > Settings > User Management > Roles
Get role information
GET /policy/api/v1/aaa/roles/<role>
System Administration > Settings > User Management > Roles
Clone an already present role
POST /policy/api/v1/aaa/roles/<role>?action=clone
System Administration > Settings > User Management > Roles
Update custom role
PUT /policy/api/v1/aaa/roles/<role>
System Administration > Settings > User Management > Users
Get the name and role information of the user.
GET /policy/api/v1/aaa/user-info
System Administration > Settings > User Management > Vidm Configuration
Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API.
GET /policy/api/v1/aaa/vidm/groups
System Administration > Settings > User Management > Vidm Configuration
Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a non paginated API.
POST /policy/api/v1/aaa/vidm/search
System Administration > Settings > User Management > Vidm Configuration
Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API.
GET /policy/api/v1/aaa/vidm/users
System Administration > Settings > User Management > Vidm Configuration
Read AAA provider vIDM properties
GET /api/v1/node/aaa/providers/vidm
GET /api/v1/transport-nodes/<transport-node-id>/node/aaa/providers/vidm
GET /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm
System Administration > Settings > User Management > Vidm Configuration
Update AAA provider vIDM properties
PUT /api/v1/node/aaa/providers/vidm
PUT /api/v1/transport-nodes/<transport-node-id>/node/aaa/providers/vidm
PUT /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm
System Administration > Settings > User Management > Vidm Configuration
Read AAA provider vIDM status
GET /api/v1/node/aaa/providers/vidm/status
GET /api/v1/transport-nodes/<transport-node-id>/node/aaa/providers/vidm/status
GET /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm/status