{
"openapi": "3.0.1",
"info": {
"title": "NSX Policy API",
"description": "VMware NSX Policy REST API",
"version": "4.2.1.0.0"
},
"servers": [
{
"url": "https://nsxmanager.your.domain/policy/api/v1"
}
],
"security": [
{
"BasicAuth": []
}
],
"tags": [
{
"name": "Tier-0 Locale Services"
},
{
"name": "Monitor"
},
{
"name": "Port Mirroring"
},
{
"name": "Gateway Firewall"
},
{
"name": "Deployments"
},
{
"name": "BGP"
},
{
"name": "Static Routes Troubleshoot Properties"
},
{
"name": "Session Timer Profiles"
},
{
"name": "NAT"
},
{
"name": "Certificates"
},
{
"name": "Nodes"
},
{
"name": "Segment Security Profile Binding"
},
{
"name": "Static Routes"
},
{
"name": "Tls Rules"
},
{
"name": "Firewall Configuration"
},
{
"name": "Communication Maps"
},
{
"name": "Kubernetes"
},
{
"name": "Rules"
},
{
"name": "Sandboxing"
},
{
"name": "Interfaces"
},
{
"name": "DNS Security Profile Bindings"
},
{
"name": "Ldap-Server"
},
{
"name": "Backup Restore Management"
},
{
"name": "NSX VPC"
},
{
"name": "API Request Batching"
},
{
"name": "Registry"
},
{
"name": "Directory Service"
},
{
"name": "Services"
},
{
"name": "Load Balancer Monitor Profiles"
},
{
"name": "Traceflow"
},
{
"name": "OSPF"
},
{
"name": "Tools"
},
{
"name": "Tier-0 Deployment Maps"
},
{
"name": "Task"
},
{
"name": "Roles"
},
{
"name": "Segments Bindings (Fixed)"
},
{
"name": "Virtual Machines"
},
{
"name": "Alb Portal Certificate"
},
{
"name": "Intrusion Services"
},
{
"name": "Metadata Proxy"
},
{
"name": "Static MIME Content"
},
{
"name": "Access Token"
},
{
"name": "Project"
},
{
"name": "Tls Inspection"
},
{
"name": "Cluster"
},
{
"name": "Security Profile Binding"
},
{
"name": "Service Segments"
},
{
"name": "Project Route Filters"
},
{
"name": "EVPN VNI Pools"
},
{
"name": "Discovery Profile Binding"
},
{
"name": "Ports"
},
{
"name": "Malware Prevention"
},
{
"name": "Signatures"
},
{
"name": "Flood Protection Profile Binding"
},
{
"name": "Labels"
},
{
"name": "Load Balancer Application Profiles"
},
{
"name": "Security Profiles"
},
{
"name": "Coordinator"
},
{
"name": "Load Balancer Profiles"
},
{
"name": "Migration"
},
{
"name": "Service Chains"
},
{
"name": "Event-Log-Server"
},
{
"name": "Check"
},
{
"name": "Error Resolver"
},
{
"name": "DNS Zones"
},
{
"name": "Multi Tenancy"
},
{
"name": "Statistics"
},
{
"name": "Networking"
},
{
"name": "Fabric"
},
{
"name": "Session Timer Profile Binding"
},
{
"name": "Lifecycle Management"
},
{
"name": "Global Managers"
},
{
"name": "Context Profiles"
},
{
"name": "Tier-1 Locale Services"
},
{
"name": "Flood Protection Profiles"
},
{
"name": "Cluster Config"
},
{
"name": "Tier-0 Gateways"
},
{
"name": "Platform"
},
{
"name": "State"
},
{
"name": "Heatmap"
},
{
"name": "Alb Onboarding Workflow"
},
{
"name": "Inventory"
},
{
"name": "IP Blocks"
},
{
"name": "Forwarding Table"
},
{
"name": "Host Agent"
},
{
"name": "Aggregated Feature State Details"
},
{
"name": "Form Factors"
},
{
"name": "Alb System Config"
},
{
"name": "NSX Advanced Load Balancer"
},
{
"name": "Load Balancer Persistence Profiles"
},
{
"name": "Usage"
},
{
"name": "DHCP Static Bindings"
},
{
"name": "Group Members"
},
{
"name": "Network Services"
},
{
"name": "Versions"
},
{
"name": "Infra"
},
{
"name": "VIDM Configuration"
},
{
"name": "Task Management"
},
{
"name": "NSX Partial Patch"
},
{
"name": "Inter Vrf"
},
{
"name": "Service Insertion"
},
{
"name": "IP Allocations"
},
{
"name": "Org"
},
{
"name": "Firewall Identity Store"
},
{
"name": "Configuration"
},
{
"name": "DAD State"
},
{
"name": "Shared Resource"
},
{
"name": "User Management"
},
{
"name": "Capacity Dashboard"
},
{
"name": "Interface Groups"
},
{
"name": "Partner Services"
},
{
"name": "Settings"
},
{
"name": "Load Balancer SSL Profiles"
},
{
"name": "Registration"
},
{
"name": "UI Views"
},
{
"name": "Upload"
},
{
"name": "Profiles"
},
{
"name": "QOS Profiles"
},
{
"name": "User Authentication"
},
{
"name": "MAC Table"
},
{
"name": "Security"
},
{
"name": "LDAP Identity Sources"
},
{
"name": "Distributed Firewall Settings"
},
{
"name": "Search API"
},
{
"name": "System Health Agent"
},
{
"name": "Feature Flag"
},
{
"name": "Domain"
},
{
"name": "Tls Profiles"
},
{
"name": "Load Balancer Services"
},
{
"name": "LDAP Servers"
},
{
"name": "Kubeconfig"
},
{
"name": "Identity Firewall Settings"
},
{
"name": "Service Definitions"
},
{
"name": "Observability"
},
{
"name": "Transport Nodes"
},
{
"name": "Storageclass"
},
{
"name": "MAC Discovery Profiles"
},
{
"name": "Cpu Memory Thresholds Profiles"
},
{
"name": "Session Timer Profile Bindings"
},
{
"name": "Subnet"
},
{
"name": "Upgrade"
},
{
"name": "Monitoring"
},
{
"name": "System Administration"
},
{
"name": "Drafts"
},
{
"name": "Controller"
},
{
"name": "Alb Auth Token"
},
{
"name": "DNS Security Profiles"
},
{
"name": "N-S Firewall"
},
{
"name": "Port"
},
{
"name": "Segments Bindings"
},
{
"name": "Community Lists"
},
{
"name": "Firewall IPFIX Profiles"
},
{
"name": "Domain Deployment Maps"
},
{
"name": "EVPN Setting"
},
{
"name": "Local Endpoints"
},
{
"name": "ARP Table"
},
{
"name": "IP Discovery Profiles"
},
{
"name": "Config"
},
{
"name": "Switch IPFIX Collectors"
},
{
"name": "Authorization"
},
{
"name": "NSX Managers"
},
{
"name": "Status"
},
{
"name": "Segments (Fixed)"
},
{
"name": "Service Instances"
},
{
"name": "Tags"
},
{
"name": "NVDS"
},
{
"name": "API Services"
},
{
"name": "Online Diagnostic System"
},
{
"name": "Bundle"
},
{
"name": "Endpoint Protection"
},
{
"name": "Connectivity"
},
{
"name": "Networking Profiles"
},
{
"name": "Widget Configuration"
},
{
"name": "Groups"
},
{
"name": "IKE Profiles"
},
{
"name": "System Health"
},
{
"name": "CSR"
},
{
"name": "Redirection Policies"
},
{
"name": "Segment Profiles"
},
{
"name": "DHCP Server Configs"
},
{
"name": "Manager IP Pools"
},
{
"name": "Search"
},
{
"name": "Ids-Ips And Malware"
},
{
"name": "Url Categorization"
},
{
"name": "DHCP Relay Configs"
},
{
"name": "Tier-1 Gateways"
},
{
"name": "Transport Zone Profiles"
},
{
"name": "NSX Application Platform"
},
{
"name": "Antrea"
},
{
"name": "Appliance"
},
{
"name": "L2VPN"
},
{
"name": "Dashboard"
},
{
"name": "DNS"
},
{
"name": "Load Balancer Pools"
},
{
"name": "Gateway Firewall Groups"
},
{
"name": "Realized State"
},
{
"name": "Backup"
},
{
"name": "Virtual Endpoints"
},
{
"name": "Container Cluster"
},
{
"name": "Constraints"
},
{
"name": "LLDP"
},
{
"name": "Reactions"
},
{
"name": "Host Transport Node Profiles"
},
{
"name": "Load Balancer Usage"
},
{
"name": "IP Management"
},
{
"name": "Aggregated Feature State"
},
{
"name": "ARP Proxies"
},
{
"name": "IPFIX"
},
{
"name": "Dashboards"
},
{
"name": "DHCP Leases"
},
{
"name": "Transport Zones"
},
{
"name": "Load Balancer SSL Ciphers And Protocols"
},
{
"name": "Cluster Control Planes"
},
{
"name": "DPD Profiles"
},
{
"name": "IPV6 DAD Profiles"
},
{
"name": "DHCP"
},
{
"name": "IPSEC"
},
{
"name": "Route Maps"
},
{
"name": "Routing"
},
{
"name": "Transport Node Collections"
},
{
"name": "Latency"
},
{
"name": "Forwarding Policies"
},
{
"name": "Hostswitch Profiles"
},
{
"name": "Container"
},
{
"name": "Gateway QOS Profiles"
},
{
"name": "Service References"
},
{
"name": "EVPN Tunnel Endpoints"
},
{
"name": "Segments"
},
{
"name": "Finetuning"
},
{
"name": "IPV6 NDRA Profiles"
},
{
"name": "Sites"
},
{
"name": "TEP Table"
},
{
"name": "Certification Revocation List"
},
{
"name": "Policy"
},
{
"name": "Switch IPFIX Profiles"
},
{
"name": "Configuration Status"
},
{
"name": "L7 Access Profiles"
},
{
"name": "Manager Configuration"
},
{
"name": "Load Balancing"
},
{
"name": "Profile"
},
{
"name": "Segment Connection Binding Map"
},
{
"name": "Inter-Vrf-Routing"
},
{
"name": "Users"
},
{
"name": "Remote-Mac"
},
{
"name": "Sessions"
},
{
"name": "Alb User Credential"
},
{
"name": "Firewall Scheduler"
},
{
"name": "Prefix List"
},
{
"name": "Bridge Endpoints"
},
{
"name": "Password Check"
},
{
"name": "Full Synchronization"
},
{
"name": "Static Routes BFD Peers"
},
{
"name": "Tunnels"
},
{
"name": "VPC"
},
{
"name": "Deployment"
},
{
"name": "North South Security"
},
{
"name": "VPN"
},
{
"name": "Tls State"
},
{
"name": "Global Gateway Configuration"
},
{
"name": "Load Balancer Virtual Servers"
},
{
"name": "Spoofguard Profiles"
},
{
"name": "Distributed Firewall"
},
{
"name": "Compliance"
},
{
"name": "Deployment Zones"
},
{
"name": "Federation Configuration"
},
{
"name": "EVPN Configuration"
},
{
"name": "QOS Profile Binding"
},
{
"name": "Quota"
},
{
"name": "Exclusion List"
},
{
"name": "Routing Table"
},
{
"name": "Monitoring Profile Binding"
},
{
"name": "Org Root"
},
{
"name": "Multicast"
},
{
"name": "Summary"
},
{
"name": "Multicast Profiles"
},
{
"name": "Constraint Global Configuration"
},
{
"name": "Domains"
},
{
"name": "Firewall IPFIX Collectors"
},
{
"name": "DNS Forwarder"
},
{
"name": "Management Plane API"
},
{
"name": "Livetrace"
},
{
"name": "Segment Security Profiles"
},
{
"name": "Distributed IDS"
},
{
"name": "Federation"
},
{
"name": "East West Security"
},
{
"name": "Restore"
},
{
"name": "E-W Firewall"
},
{
"name": "API Usage"
},
{
"name": "Security Configuration"
},
{
"name": "IP Pools"
},
{
"name": "Load Balancer Server SSL Profiles"
},
{
"name": "IP Reputation"
},
{
"name": "IPSEC Profiles"
},
{
"name": "Enablement"
},
{
"name": "Vm"
},
{
"name": "Hierarchical API"
},
{
"name": "Edge Bridge Profiles"
},
{
"name": "IP Address Pools"
},
{
"name": "Object Permissions"
},
{
"name": "Inter-Sites"
},
{
"name": "Licenses"
},
{
"name": "EVPN Tenant Configuration"
},
{
"name": "Load Balancer Client SSL Profiles"
},
{
"name": "Enforcement Points"
},
{
"name": "BFD Profiles"
}
],
"paths": {
"/orgs/{org-id}/projects/{project-id}/infra/context-profiles/custom-attributes": {
"post": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Adds/Removes custom attribute values from list",
"description": "This API adds/removes custom attribute values from list for a given attribute key.\n\n
\nThis rest routine is deprecated. Use /infra/context-profiles/custom-attributes/default\nto Adds/Removes custom attribute values from list\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraAddRemoveCustomAttributeValues",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Add or Remove Custom Context Profile Attribute values.",
"required": true,
"schema": {
"type": "string",
"enum": [
"add",
"remove"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyAttributes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes?action=add\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.office365.com\", \"*.azure.com\"\n ],\n \"datatype\":\"STRING\"\n}\n",
"x-codegen-request-body-name": "PolicyAttributes"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Update custom object attribute value list for given attribute key",
"description": "This API updates custom attribute value list for given key.\n\n
\nThis rest routine is deprecated. Use /infra/context-profiles/custom-attributes/default\nfor create/update custom object attribute value list for given attribute key\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchCustomAttributeList",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyAttributes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.office365.com\", \"*.azure.com\"\n ],\n \"datatype\":\"STRING\"\n}\n",
"x-codegen-request-body-name": "PolicyAttributes"
}
},
"/infra/tier-0s?action=site_failover": {
"post": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Routing",
"Tier-0 Gateways"
],
"summary": "Recover of Tier0 and linked tier1 gateway(s).",
"description": "API to recover specified Tier0 gateway and linked tier1 gateway from\nprimary site path to new primary site path. This will update intent of\naffected Tier-0 and Tier-1 gateway.\n",
"operationId": "GatewaySiteFailoverAction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewaySiteFailoverActionConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-0s?action=site_failover\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "GatewaySiteFailoverActionConfig"
}
},
"/infra/realized-state/enforcement-points/{enforcement-point-name}/groups/securitygroups": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "List Security Groups",
"description": "Paginated list of all Security Groups. Returns populated Security Groups.\n",
"operationId": "ListSecurityGroupRealizedStates",
"parameters": [
{
"name": "enforcement-point-name",
"in": "path",
"description": "Enforcement Point Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealizedSecurityGroupListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyRealizedState"
}
},
"/infra/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings"
],
"summary": "Read DHCP static binding state",
"description": "Read DHCP static binding state",
"operationId": "ReadInfraSegmentDhcpStaticBindingState",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web_seg/dhcp-static-bindings/server1/state\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"details\": [\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"fe651e63-04bd-43a4-a8ec-45381a3b71b9\",\n \"state\": \"in_progress\",\n \"failure_message\": \"CCP Id:ab5958df-d98a-468e-a72b-d89dcdae5346, Message:State realization is in progress at the node.\"\n },\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"ebe174ac-e4f1-4135-ba72-3dd2eb7099e3\",\n \"state\": \"in_sync\"\n }\n ],\n \"state\": \"in_progress\",\n \"failure_message\": \"The state realization is in progress at transport nodes.\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Status"
],
"summary": "Get IPSec VPN session detailed status under Tier-1",
"description": "- no enforcement point path specified: detailed status is evaluated on each enforcement point.\n- an enforcement point path is specified: detailed status is evaluated only on the given\nenforcement point.\n- source=realtime: detailed status is fetched realtime from the enforcement point.\n- source=cached: cached detailed status from enforcement point is returned.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1VpnIPSecVpnSessionStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateIPSecVpnSessionStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1/detailed-status\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"OSPF"
],
"summary": "Read OSPF Area config",
"description": "Read OSPF Area config\n",
"operationId": "ReadOspfAreaConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "area-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OspfAreaConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/ospf/areas/area1\n",
"x-vmw-nsx-module": "PolicyOspf",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"OspfAreaConfig\",\n \"id\": \"area1\",\n \"display_name\": \"area1\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/default/ospf/areas/area1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv/locale-services/default\",\n \"relative_path\": \"area1\",\n \"area_id\": \"1.1.1.1\",\n \"area_type\": \"NORMAL\",\n \"authentication\": {\n \"mode\": \"PASSWORD\"\n }\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751200877,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751200877,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"OSPF"
],
"summary": "Create or update a OSPF Area config",
"description": "If OSPF Area config is not already present, create OSPF Area config.\nIf it already exists, replace the OSPF Area config with this object.\n",
"operationId": "CreateOrReplaceOspfAreaConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "area-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OspfAreaConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OspfAreaConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/ospf/areas/area1\n{\n \"area_id\": \"1.1.1.1\",\n \"area_type\": \"NORMAL\",\n \"authentication\": {\n \"mode\": \"PASSWORD\",\n \"secret_key\": \"key_foo\"\n }\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyOspf",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"OspfAreaConfig\",\n \"id\": \"area1\",\n \"display_name\": \"area1\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/default/ospf/areas/area1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv/locale-services/default\",\n \"relative_path\": \"area1\",\n \"area_id\": \"1.1.1.1\",\n \"area_type\": \"NORMAL\",\n \"authentication\": {\n \"mode\": \"PASSWORD\"\n }\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751200877,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751200877,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "OspfAreaConfig"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"OSPF"
],
"summary": "Delete OSPF Area config",
"description": "Delete OSPF Area config\n",
"operationId": "DeleteOspfAreaConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "area-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/ospf/areas/area1\n",
"x-vmw-nsx-module": "PolicyOspf",
"x-vmw-nsx-example-response": "{\n}\n"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"OSPF"
],
"summary": "Create or update a OSPF Area config",
"description": "If OSPF Area config is not already present, create OSPF Area config.\nIf it already exists, replace the OSPF Area config with this object.\n",
"operationId": "PatchOspfAreaConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "area-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OspfAreaConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OspfAreaConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/ospf/areas/area1\n{\n \"area_id\": \"1.1.1.1\",\n \"area_type\": \"NORMAL\",\n \"authentication\": {\n \"mode\": \"PASSWORD\",\n \"secret_key\": \"key_foo\"\n }\n}\n",
"x-vmw-nsx-module": "PolicyOspf",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"OspfAreaConfig\",\n \"id\": \"area1\",\n \"display_name\": \"area1\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/default/ospf/areas/area1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv/locale-services/default\",\n \"relative_path\": \"area1\",\n \"area_id\": \"1.1.1.1\",\n \"area_type\": \"NORMAL\",\n \"authentication\": {\n \"mode\": \"PASSWORD\"\n }\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751200877,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751200877,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "OspfAreaConfig"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/affected-users": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Dashboard"
],
"summary": "Get the list of the users affected for that signature",
"description": "Get the list of the users affected pertaining to a specific\nsignature.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPolicyAffectedUsers",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsEventDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsUserList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/affected-users\n {\n \"filters\": [\n {\n \"field_names\":\"intrusion_timestamp\",\"value\":\" >1590533447645\"\n },\n {\n \"field_names\": \"signature_detail.signature_id\",\n \"value\": \"(4010643)\"\n }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyIDSMetrics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n \"administrator\",\n \"auditor\"\n ],\n \"result_count\": 2,\n \"sort_by\": \"displayName\",\n \"sort_ascending\": false,\n \"cursor\": \"2\"\n}\n",
"x-codegen-request-body-name": "PolicyIdsEventDataRequest"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Read DHCP server state",
"description": "Read DHCP server state",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadDhcpServerState",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServerState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/state?connectivity_path=/infra/tier-1s/it_t1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"details\": [\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"fe651e63-04bd-43a4-a8ec-45381a3b71b9\",\n \"state\": \"in_progress\",\n \"failure_message\": \"CCP Id:ab5958df-d98a-468e-a72b-d89dcdae5346, Message:State realization is in progress at the node.\"\n },\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"ebe174ac-e4f1-4135-ba72-3dd2eb7099e3\",\n \"state\": \"in_sync\"\n }\n ],\n \"state\": \"in_progress\",\n \"failure_message\": \"The state realization is in progress at transport nodes.\"\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "List all DHCP static bindings",
"description": "Paginated list of all DHCP static binding instances\n",
"operationId": "GlobalInfraListSegmentDhcpStaticBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"address1\",\n \"path\": \"/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/tier-1s/mgw/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595467058,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"TEP Table"
],
"summary": "Get tier-1 segment TEP table",
"description": "Returns TEP table for a segment\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1SegmentTepTable",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTepListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH/tep-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"last_update_timestamp\": 1591745956155,\n \"results\": [\n {\n \"tep_label\": 55298,\n \"tep_ip\": \"100.100.100.3\",\n \"tep_mac_address\": \"00:50:56:6a:af:ce\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/certificates": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certificates"
],
"summary": "Return All the User-Facing Components' Certificates",
"description": "Returns all certificate information viewable by the user, including each\ncertificate's id; pem_encoded data; and history of the\ncertificate (who created or modified it and when). For additional\ninformation, include the ?details=true modifier at the end of the request\nURI.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTlsCertificates",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "whether to expand the pem data and show all its details",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "node_id",
"in": "query",
"description": "Node ID of certificate to return",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type of certificate to return",
"schema": {
"type": "string",
"enum": [
"cluster_api_certificate",
"api_certificate"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCertificateList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/certificates\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"TlsCertificate\",\n \"id\": \"caCert\",\n \"display_name\": \"caCert\",\n \"path\": \"/infra/certificates/caCert\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"caCert\",\n \"details\": [ ... ],\n \"pem_encoded\": \"-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n\",\n \"has_private_key\": false,\n \"tls_certificate_type\": \"CERTIFICATE_CA\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516329725649,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516329725649,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"TlsCertificate\",\n \"id\": \"selfSignedCert\",\n \"display_name\": \"selfSignedCert\",\n \"path\": \"/infra/certificates/selfSignedCert\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"selfSignedCert\",\n \"details\": [\n {\n \"issuer_cn\": \"vSM Test Certificate\",\n \"public_key_length\": 1024,\n \"signature\": \"4e cf ff 36 ac a1\",\n \"not_before\": 1323772715000,\n \"subject\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"serial_number\": \"ca55f5e21a0b2dd2\",\n \"public_key_algo\": \"RSA\",\n \"version\": \"1\",\n \"issuer\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"is_ca\": false,\n \"subject_cn\": \"vSM Test Certificate\",\n \"not_after\": 1355308715000,\n \"is_valid\": false,\n \"rsa_public_key_exponent\": \"10001\",\n \"signature_algorithm\": \"SHA1WITHRSA\",\n \"rsa_public_key_modulus\": \"00 b7 8f 79 e4\"\n }\n ],\n \"pem_encoded\": \"-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n\",\n \"has_private_key\": true,\n \"tls_certificate_type\": \"CERTIFICATE_SELF_SIGNED\",\n \"unique_id\": \"e523b4c0-c3c5-4656-80a1-36dd0fab38cb\",\n \"realization_id\": \"e523b4c0-c3c5-4656-80a1-36dd0fab38cb\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516338671237,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516338671237,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"MAC Table"
],
"summary": "Get infra segment port MAC table in CSV",
"description": "Returns MAC table for a segment port\n",
"operationId": "GetInfraSegmentPortMacTableInCsv",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/SegmentPortMacAddressCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWN_LINK_SWITCH/ports/default:d808cd01-b20b-485b-8e57-983a84fa7642/mac-table?format=csv&source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,mac_type\n00:0c:29:ce:0f:77,STATIC\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "List IDS security policies",
"description": "List intrusion detection system security policies.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIdsSecurityPolicies",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsSecurityPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp12\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp12\",\n \"relative_path\": \"sp12\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"a3aaa996-2c03-482a-af44-06b2c7ec4937\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 2500,\n \"internal_sequence_number\": 2500,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711475948,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714047068,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 14\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp16\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp16\",\n \"relative_path\": \"sp16\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"445aaefb-6d0a-4e19-bd62-f56c1e0870e1\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 5000,\n \"internal_sequence_number\": 5000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582713996647,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046874,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp17\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp17\",\n \"relative_path\": \"sp17\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"adf57370-853e-4db8-b248-393d7fb4e88e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 10000,\n \"internal_sequence_number\": 10000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582714000481,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046893,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp15\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp15\",\n \"relative_path\": \"sp15\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"c83df674-3879-4ef7-8b79-d562f14ff2ef\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 15000,\n \"internal_sequence_number\": 15000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582713987733,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046919,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp13\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp13\",\n \"relative_path\": \"sp13\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"85816222-5cee-4135-b524-377bd00f4e70\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 20000,\n \"internal_sequence_number\": 20000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711483215,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046963,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 14\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp14\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp14\",\n \"relative_path\": \"sp14\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"17d3909c-d8cd-4809-94e8-1f6215496dd7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 25000,\n \"internal_sequence_number\": 25000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711487000,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046987,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 10\n }\n],\n\"result_count\": 6,\n\"sort_by\": \"sequence_number\",\n\"sort_ascending\": true\n }\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/tunnels/{tunnel-name}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Heatmap"
],
"summary": "Tunnel properties",
"description": "Tunnel properties",
"operationId": "GetTunnelByName",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "node-id",
"in": "path",
"description": "ID of transport node",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-name",
"in": "path",
"description": "Tunnel name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelProperties"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1/tunnels/stt3232299620\n",
"x-vmw-nsx-module": "PolicyHeatmap",
"x-vmw-nsx-example-response": "{\n \"local_ip\": \"192.168.250.101\",\n \"bfd\": {\n \"remote_state\": \"DOWN\",\n \"remote_diagnostic\": \"CONTROL_DETECTION_TIME_EXPIRED\",\n \"active\": true,\n \"state\": \"INIT\",\n \"forwarding\": false,\n \"diagnostic\": \"NEIGHBOR_SIGNALED_SESSION_DOWN\"\n },\n \"remote_ip\": \"192.168.250.100\",\n \"egress_interface\": \"vmk10\",\n \"name\": \"stt3232299620\",\n \"encap\": \"STT\",\n \"status\": \"DOWN\",\n \"remote_node_id\": \"4fa0d456-627d-4b62-9bfe-585d585dab1a\"\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "List IDS Custom Signatures",
"description": "List IDS Custom Signatures.\n",
"operationId": "ListIdsCustomSignatures",
"parameters": [
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "Custom signatures to be returned",
"schema": {
"type": "string",
"enum": [
"PREVIEW_CUSTOM_SIGNATURES",
"CUSTOM_SIGNATURES"
]
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsCustomSignatureListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1/custom-signatures?include=PREVIEW_CUSTOM_SIGNATURES\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001061397\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001061397\",\n \"relative_path\": \"1001061397\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - (Initial Access) Detect CVE-2014-6332\",\n \"class_type\": \"attempted-user\",\n \"severity\": \"HIGH\",\n \"signature_revision\": \"3565\",\n \"signature_id\": \"1001061397\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"9.3\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"cves\": [\n \"2014-6332\"\n ],\n \"flow\": \"established,to_server\",\n \"action\": \"reject\",\n \"enable\": true,\n \"impact\": \"52\",\n \"risk_score\": \"75\",\n \"confidence\": \"70\",\n \"mitre_attack\": [\n {\n \"tactic_url\": \"https://attack.mitre.org/tactics/TA0001/\",\n \"tactic_name\": \"Initial Access\",\n \"technique_name\": \"Drive-by Compromise\",\n \"technique_url\": \"https://attack.mitre.org/techniques/T1189/\"\n }\n ],\n \"signature\": \"reject http $HOME_NET any -> $EXTERNAL_NET any (msg:\\\"NSX - (Initial Access) Detect CVE-2014-6332\\\"; flow:established,to_server; target:src_ip; content:\\\"GET\\\"; nocase; http_method; content:\\\"?MTIzNDU2\\\"; http_uri; pcre:\\\"/\\/\\\\?MTIzNDU2[A-Za-z0-9+\\/=]*&d=[a-z0-9]{32} HTTP/\\\"; flowbits:set,LL.verifier_http_successful; flowbits:set,LL.verifier_http_failed; flowbits:set,LL.verifier_http_blocked; threshold: type limit, track by_src, seconds 180, count 1; metadata:ll_expected_verifier default, flip_endpoints False, server_side False, threat_class_name drive-by, threat_name CVE-2014-6332, ids_mode REAL, blacklist_mode DISABLED, exploited None, confidence 70, severity 75, detector_id 61397, signature_severity High; reference:url,www.lastline.com; classtype:attempted-user; sid:1061397; rev:3565; priority:2;)\",\n \"original_signature_id\": \"1061397\",\n \"validation_status\": \"WARNING\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995216,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995216,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001060933\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001060933\",\n \"relative_path\": \"1001060933\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - Detect Zeus activity\",\n \"class_type\": \"trojan-activity\",\n \"severity\": \"CRITICAL\",\n \"signature_revision\": \"3007\",\n \"signature_id\": \"1001060933\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"0.0\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"flow\": \"established,to_client\",\n \"action\": \"reject\",\n \"enable\": false,\n \"impact\": \"80\",\n \"risk_score\": \"100\",\n \"confidence\": \"80\",\n \"signature\": \"reject http $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - Detect Zeus activity\\\"; flow:established,to_client; target:dest_ip; content:\\\"|00 00 00 00 8D|L|C8 15 F6|dps|C7|VQ5|03|C|DD|&\\\"; pcre:\\\"/^\\\\x00\\\\x00\\\\x00\\\\x00\\\\x8DL\\\\xC8\\\\x15\\\\xF6dps\\\\xC7VQ5\\\\x03C\\\\xDD&/Q\\\"; threshold: type limit, track by_dst, seconds 180, count 1; metadata:ll_verifier_outcome successful, flip_endpoints True, server_side False, threat_class_name command&control, threat_name Zeus Variant, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 80, severity 100, detector_id 60921, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060921; rev:3007; priority:1;)\",\n \"original_signature_id\": \"1060933\",\n \"validation_status\": \"INVALID\",\n \"validation_message\": \"test message\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995213,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995213,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001060921\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001060921\",\n \"relative_path\": \"1001060921\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - Detect Zeus activity\",\n \"class_type\": \"trojan-activity\",\n \"severity\": \"CRITICAL\",\n \"signature_revision\": \"3007\",\n \"signature_id\": \"1001060921\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"0.0\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"flow\": \"established,to_client\",\n \"action\": \"reject\",\n \"enable\": true,\n \"impact\": \"80\",\n \"risk_score\": \"100\",\n \"confidence\": \"80\",\n \"signature\": \"reject http $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - Detect Zeus activity\\\"; flow:established,to_client; target:dest_ip; content:\\\"|00 00 00 00 8D|L|C8 15 F6|dps|C7|VQ5|03|C|DD|&\\\"; pcre:\\\"/^\\\\x00\\\\x00\\\\x00\\\\x00\\\\x8DL\\\\xC8\\\\x15\\\\xF6dps\\\\xC7VQ5\\\\x03C\\\\xDD&/Q\\\"; threshold: type limit, track by_dst, seconds 180, count 1; metadata:ll_verifier_outcome successful, flip_endpoints True, server_side False, threat_class_name command&control, threat_name Zeus Variant, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 80, severity 100, detector_id 60921, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060921; rev:3007; priority:1;)\",\n \"original_signature_id\": \"1060921\",\n \"validation_status\": \"VALID\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995211,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995211,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001061571\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001061571\",\n \"relative_path\": \"1001061571\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - (Initial Access) Detect transfer of the Metasploit payload windows/x64/vncinject/reverse_tcp_uuid\",\n \"class_type\": \"attempted-user\",\n \"severity\": \"HIGH\",\n \"signature_revision\": \"1\",\n \"signature_id\": \"1001061571\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"0.0\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"flow\": \"established,to_client\",\n \"action\": \"reject\",\n \"enable\": true,\n \"impact\": \"52\",\n \"risk_score\": \"75\",\n \"confidence\": \"70\",\n \"mitre_attack\": [\n {\n \"tactic_url\": \"https://attack.mitre.org/tactics/TA0001/\",\n \"tactic_name\": \"Initial Access\",\n \"technique_name\": \"Exploit Public-Facing Application\",\n \"technique_url\": \"https://attack.mitre.org/techniques/T1190/\"\n }\n ],\n \"signature\": \"reject tcp $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - (Initial Access) Detect transfer of the Metasploit payload windows/x64/vncinject/reverse_tcp_uuid\\\"; flow:established,to_client; target:dest_ip; content:\\\"|FC|H|83 E4 F0 E8 CC 00 00 00|AQAPR\\\"; content:\\\"QVH1|D2|eH|8B|R|60|H|8B|R|18|H\\\"; content:\\\"|8B|R H|8B|rPH|0F B7|JJM1|C9|\\\"; content:\\\"H1|C0 AC| $EXTERNAL_NET any (msg:\\\"NSX - Detect Fareit\\\"; flow:established,to_server; target:src_ip; content:\\\"POST /\\\"; content:\\\"news.php\\\"; content:\\\"HTTP/\\\"; content:\\\"Host|3A|\\\"; content:\\\"Accept|3A| |2A|/|2A|\\\"; content:\\\"Connection|3A| close\\\"; content:\\\"Content-Encoding|3A| binary\\\"; content:!\\\"Referer|3A|\\\"; pcre:\\\"/\\\\xFF/P\\\"; flowbits:set,LL.verifier_http_successful; flowbits:set,LL.verifier_http_failed; flowbits:set,LL.verifier_http_blocked; threshold: type limit, track by_src, seconds 180, count 1; metadata:ll_expected_verifier default, flip_endpoints False, server_side False, threat_class_name command&control, threat_name Fareit, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 85, severity 100, detector_id 60759, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060759; rev:2778; priority:1;)\",\n \"original_signature_id\": \"1060759\",\n \"validation_status\": \"VALID\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995213,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995213,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n }\n],\n\"result_count\": 5,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
},
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Publish/Cancel/Validate the custom signatures",
"description": "Publish/Cancel/Validate the customer signatures.\nCANCEL: Revert to earlier published state i.e. cancel/remove all the unpublished custom signatures.\nVALIDATE: Trigger the validation of the custom signatures.\nPUBLISH: Publish the custom signatures. This action will push all the valid custom signatures to datapath.\n",
"operationId": "ApplyCustomSignaturesAction",
"parameters": [
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Different Actions on Custom signatures",
"required": true,
"schema": {
"type": "string",
"enum": [
"CANCEL",
"PUBLISH",
"VALIDATE"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomSignatureValidationPayload"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "\nPOST https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/custom-signatures?action=PUBLISH\n {\n \"modified_signatures\": [\n {\n \"signature_id\": \"1001061397\",\n \"overridden_signature\": {\n \"action\": \"DROP\"\n }\n }\n ]\n }\n\nPOST https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/custom-signatures?action=VALIDATE\n {\n \"modified_signatures\": [\n {\n \"signature_id\": \"1001061397\",\n \"overridden_signature\": {\n \"action\": \"DROP\"\n }\n },\n {\n \"signature_id\": \"1001060933\",\n \"raw_signature\": \"reject http $HOME_NET any -> $EXTERNAL_NET any (msg:\\\"NSX - (Initial Access) Detect CVE-2014-6332\\\"; flow:established,to_server; target:src_ip; content:\\\"GET\\\"; nocase; http_method; content:\\\"?MTIzNDU2\\\"; http_uri; pcre:\\\"/\\/\\\\?MTIzNDU2[A-Za-z0-9+\\/=]*&d=[a-z0-9]{32} HTTP/\\\"; flowbits:set,LL.verifier_http_successful; flowbits:set,LL.verifier_http_failed; flowbits:set,LL.verifier_http_blocked; threshold: type limit, track by_src, seconds 180, count 1; metadata:ll_expected_verifier default, flip_endpoints False, server_side False, threat_class_name drive-by, threat_name CVE-2014-6332, ids_mode REAL, blacklist_mode DISABLED, exploited None, confidence 70, severity 75, detector_id 61397, signature_severity High; reference:url,www.lastline.com; classtype:attempted-user; sid:1061397; rev:3565; priority:2;)\"\n }\n ]\n}\n\nPOST https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/custom-signatures?action=CANCEL\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-vmw-nsx-example-response": "",
"x-codegen-request-body-name": "CustomSignatureValidationPayload"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/endpoints/virtual-endpoints": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Virtual Endpoints",
"Tier-0 Gateways"
],
"summary": "List all virtual endpoints",
"description": "List all virtual endpoints",
"operationId": "ListVirtualEndpointsForTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualEndpointListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/l1/endpoints/virtual-endpoints\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"VirtualEndpoint\",\n \"id\": \"VEP_1\",\n \"display_name\": \"VEP_1\",\n \"path\": \"/infra/tier-0s/vmc/locale-services/l1/endpoints/virtual-endpoints/VEP_1\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"VEP_1\",\n \"marked_for_delete\": false,\n \"target_ips\": [\n {\n \"ip_addresses\": [\n \"111.111.112.11\"\n ],\n \"prefix_length\": 32\n }\n ],\n \"service_names\": [\n \"HCX_Service\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1526676234605,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1526676234605,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/host-transport-nodes/{host-transport-node-id}/vteps/actions": {
"post": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Nodes"
],
"summary": "Submit a new TransportNode VTEP action",
"description": "Submit a new VTEP action for a particular TransportNode. The status of submitted actions could be retrieved using\nthe ListTransportNodeVtepActionsStatus API.\n",
"operationId": "SubmitTransportNodeVtepAction",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "host-transport-node-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransportNodeVtepAction"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransportNodeVtepActionReference"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes//vteps/actions\n{\n \"action_type\": \"TransportNodeVtepRecoveryRequest\",\n \"device_name\": \"vmk10\"\n}\n\nPOST https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes//vteps/actions\n{\n \"action_type\": \"TransportNodeVtepAdminStateMgmtRequest\",\n \"device_name\": \"vmk10\",\n \"admin_state_up\": false\n}\n",
"x-vmw-nsx-module": "PolicyHostTransportNode",
"x-codegen-request-body-name": "TransportNodeVtepAction"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Get Infra Segment Discovery Profile Binding Map",
"description": "API will get Infra Segment Discovery Profile Binding Map\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Update Infra Segment Discovery Profile Binding Map",
"description": "API will update Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n{\n \"resource_type\":\" SegmentDiscoveryProfileBindingMap\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SegmentDiscoveryProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Delete Segment Discovery Profile Binding Profile",
"description": "API will delete Segment Discovery Profile Binding Profile",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Create Infra Segment Discovery Profile Binding Map",
"description": "API will create Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n {\n \"resource_type\":\" SegmentDiscoveryProfileBindingMap\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n }\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-codegen-request-body-name": "SegmentDiscoveryProfileBindingMap"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/kubernetes-node-pod-cidrs": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get kubernetes node pod cidrs that belong to this Group",
"description": "Get kubernetes node pod cidrs that belong to this Group. This API is applicable for Groups\ncontaining KubernetesNode member type with key as POD_CIDRS. For\nGroups containing other member types an empty list is returned\n",
"operationId": "GetGroupPodCidrMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster_id",
"in": "query",
"description": "Cluster ID",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupPodCidrListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/kubernetes-node-pod-cidrs?cluster_id=6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"clusters\": [\n {\n \"external_id\": \"6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"ANTK01\",\n \"kubernetes_nodes\" : [ \n {\n \"pod_cidrs\" : [ \"10.221.121.206/32\", \"FE80::/64\" ],\n \"external_id\" : \"873eee86-8331-4b84-a278-4b132f4cbd17\",\n \"display_name\" : \"workload-control-plane-jsz27\"\n }, \n {\n \"pod_cidrs\" : [ \"10.221.121.205/32\", \"FE80::/64\" ],\n \"external_id\" : \"cc54a04d-0aba-4a24-9e6a-0a7372202242\",\n \"display_name\" : \"workload-md-0-d4c86fd4d-kqd56\"\n }\n ]\n }\n ]\n }\n],\n\"result_count\": 2,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/l2vpn-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Get L2VPN service list result under Tier-1",
"description": "Get paginated list of all L2VPN services under Tier-1.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1VpnL2VPNServices",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-1s/cgw/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/global-infra/segments/{segment-id}/arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from segment interface (downlink) in CSV format",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the\ninterface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge\nnode specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "GlobalInfraGetInfraSegmentInterfaceArpTableCsv",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web-app-seg/arp-table?format=csv&enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,ip\n02:50:56:56:44:52,172.16.20.1\n"
}
},
"/infra/lb-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Services"
],
"summary": "List LBService",
"description": "Paginated list of all LBService.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "ListLBServices",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/lb-services\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"LBService\",\n \"id\": \"cgwLbService\",\n \"display_name\": \"cgwLbService\",\n \"path\": \"/infra/lb-services/cgwLbService\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"cgwLbService\",\n \"marked_for_delete\": false,\n \"size\": \"SMALL\",\n \"error_log_level\": \"INFO\",\n \"access_log_enabled\": false,\n \"enabled\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1531109024949,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1531109024949,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"NAT",
"Statistics"
],
"summary": "Get NAT Rule Statistics",
"description": "Get NAT Rule Statistics from Tier-1 denoted by Tier-1 ID, under NAT section\ndenoted by <nat-id>.\nUnder tier-1 there will be 3 different NATs(sections).\n(INTERNAL, USER and DEFAULT)\nFor more details related to NAT section please refer to PolicyNAT schema.\n",
"operationId": "GetPolicyNatRuleStatisticsFromTier1",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action on statistics",
"schema": {
"type": "string",
"enum": [
"aggregate"
]
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyNatRuleStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyNAT",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"rule_path\": \"/infra/tier-1s/network/nat/USER/nat-rules/1\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"rule_statistics\": [\n {\n \"total_bytes\": 0,\n \"active_sessions\": 0,\n \"total_packets\": 0,\n \"last_update_timestamp\": 1537502752201\n },\n {\n \"total_bytes\": 0,\n \"active_sessions\": 0,\n \"total_packets\": 0,\n \"last_update_timestamp\": 1537502753915\n }\n ]\n }\n ]\n }\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Locale Services"
],
"summary": "List Tier-1 locale-services",
"description": "Paginated list of all Tier-1 locale-services\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1LocaleServices",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServicesListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"LocaleServices\",\n \"id\": \"palo_alto\",\n \"display_name\": \"Palo Alto\",\n \"path\": \"/infra/tier-1s/cgw/locale-services/palo_alto\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"palo_alto\",\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/{sig-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Get IDS Custom Signature",
"description": "Get IDS Custom Signature.\n",
"operationId": "GetIdsCustomSignature",
"parameters": [
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sig-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsCustomSignature"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1/custom-signatures/1001060921\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-vmw-nsx-example-response": "{\n\"original_signature_id\": \"1060921\",\n\"validation_status\": \"VALID\",\n\"resource_type\": \"IdsCustomSignature\",\n\"id\": \"1001060921\",\n\"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures/1001060921\",\n\"relative_path\": \"1001060921\",\n\"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n\"marked_for_delete\": false,\n\"overridden\": false,\n\"name\": \"NSX - Detect Zeus activity\",\n\"class_type\": \"trojan-activity\",\n\"severity\": \"CRITICAL\",\n\"signature_revision\": \"3007\",\n\"signature_id\": \"1001060921\",\n\"categories\": [\n \"APPLICATION\"\n],\n\"cvssv3\": \"0.0\",\n\"cvssv2\": \"0.0\",\n\"attack_target\": \"Client_Endpoint\",\n\"product_affected\": \"NONE\",\n\"flow\": \"established,to_client\",\n\"action\": \"reject\",\n\"enable\": true,\n\"impact\": \"80\",\n\"risk_score\": \"100\",\n\"confidence\": \"80\",\n\"signature\": \"reject http $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - Detect Zeus activity\\\"; flow:established,to_client; target:dest_ip; content:\\\"|00 00 00 00 8D|L|C8 15 F6|dps|C7|VQ5|03|C|DD|&\\\"; pcre:\\\"/^\\\\x00\\\\x00\\\\x00\\\\x00\\\\x8DL\\\\xC8\\\\x15\\\\xF6dps\\\\xC7VQ5\\\\x03C\\\\xDD&/Q\\\"; threshold: type limit, track by_dst, seconds 180, count 1; metadata:ll_verifier_outcome successful, flip_endpoints True, server_side False, threat_class_name command&control, threat_name Zeus Variant, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 80, severity 100, detector_id 60921, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060921; rev:3007; priority:1;)\",\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_create_time\": 1717743290322,\n\"_create_user\": \"admin\",\n\"_last_modified_time\": 1717743290322,\n\"_last_modified_user\": \"admin\",\n\"_revision\": 0\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/cluster-control-planes/{cluster-control-plane-id}": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Cluster Control Planes"
],
"summary": "Get a Cluster Control Plane",
"description": "Returns information about a specified Cluster Control Plane .",
"operationId": "GetClusterControlPlane",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-control-plane-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterControlPlane"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites//enforcement-points//cluster-control-planes/p1\n",
"x-vmw-nsx-module": "ClusterControlPlane",
"x-vmw-nsx-example-response": "{\n\"node_id\" : \"df47a291-deae-44cb-8773-59670369aff2\",\n\"vhc_path\" : \"/xx/yy\",\n\"certificate\": \"-----BEGIN CERTIFICATE--------END CERTIFICATE-----\\n\"\n\"resource_type\" : \"ClusterControlPlane\",\n\"display_name\" : \"p1\",\n\"_create_user\" : \"admin\",\n\"_create_time\" : 1610960457601,\n\"_last_modified_user\" : \"admin\",\n\"_last_modified_time\" : 1610960457601,\n\"_system_owned\" : false,\n\"_protection\" : \"NOT_PROTECTED\",\n\"_revision\" : 0\n}\n"
},
"put": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Cluster Control Planes"
],
"summary": "Create or Update Cluster Control Plane to NSX-T",
"description": "Joins a Cluster Control Plane to NSX-T\n",
"operationId": "CreateOrUpdateClusterControlPlane",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-control-plane-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterControlPlane"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterControlPlane"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/sites//enforcement-points//cluster-control-planes/p1\n{\n \"resource_type\": \"ClusterControlPlane\",\n \"vhc_path\": \"/xxx/yyy\",\n \"certificate\": \"-----BEGIN CERTIFICATE--------END CERTIFICATE-----\\n\"\n}\n",
"x-vmw-nsx-module": "ClusterControlPlane",
"x-vmw-nsx-example-response": "{\n \"node_id\" : \"df47a291-deae-44cb-8773-59670369aff2\",\n \"vhc_path\" : \"/xx/yy\",\n \"certificate\": \"-----BEGIN CERTIFICATE--------END CERTIFICATE-----\\n\"\n \"resource_type\" : \"ClusterControlPlane\",\n \"display_name\" : \"p1\",\n \"_create_user\" : \"admin\",\n \"_create_time\" : 1610960457601,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1610960457601,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 0\n}\n",
"x-codegen-request-body-name": "ClusterControlPlane"
},
"delete": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Cluster Control Planes"
],
"summary": "Delete a Cluster Control Plane Node",
"description": "Delete a Cluster Control Plane Node",
"operationId": "DeleteClusterControlPlane",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-control-plane-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cascade",
"in": "query",
"description": "Flag to indicate if force delete cluster references from the firewall security policies.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/sites//enforcement-points//cluster-control-planes/p1\n",
"x-vmw-nsx-module": "ClusterControlPlane"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"DAD State"
],
"summary": "Get DAD state for downlink router port on tier-1 router",
"description": "Segment ID is the ID of the segment that is connected to the the tier-1\n",
"operationId": "GetDownlinkPortDadStateForTier1Segment",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceDADState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH/gateway-interface-dad-state\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_path\": \"/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH\",\n \"dad_statuses\": []\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Domains",
"Domain"
],
"summary": "Read domain",
"description": "Read a domain.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadDomainForInfra",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Domain"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Domain\",\n \"description\": \"VMC Domain\",\n \"id\": \"vmc\",\n \"display_name\": \"VMC domain\",\n \"path\": \"/infra/domains/vmc\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"vmc\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517307910473,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517307910473,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/labels/{label-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Labels"
],
"summary": "Read lable",
"description": "Read a label.\n",
"operationId": "ReadPolicyLabelForInfra",
"parameters": [
{
"name": "label-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLabel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/labels/my-domains-label\n",
"x-vmw-nsx-module": "PolicyLabel",
"x-vmw-nsx-example-response": "{\n \"type\": \"Domain\",\n \"refs\": [\n \"/infra/domains/mydomain3\",\n \"/infra/domains/mydomain2\",\n \"/infra/domains/mydomain1\"\n ],\n \"resource_type\": \"PolicyLabel\",\n \"id\": \"my-domains-label\",\n \"display_name\": \"my-domains-label\",\n \"path\": \"/infra/labels/my-domains-label\",\n \"relative_path\": \"my-domains-label\",\n \"parent_path\": \"/infra/labels/my-domains-label\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544641564432,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544641564432,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Infra",
"Labels"
],
"summary": "Create or replace label",
"description": "Create label if not exists, otherwise replaces the existing label.\nIf label already exists then type attribute cannot be changed.\n",
"operationId": "CreateOrReplacePolicyLabelForInfra",
"parameters": [
{
"name": "label-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLabel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLabel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/labels/my-domains-label\n{\n \"type\" : \"Domain\",\n \"refs\" : [\"/infra/domains/mydomain1\", \"/infra/domains/mydomain2\", \"/infra/domains/mydomain3\"]\n}\n",
"x-vmw-nsx-module": "PolicyLabel",
"x-vmw-nsx-example-response": "{\n \"type\": \"Domain\",\n \"refs\": [\n \"/infra/domains/mydomain3\",\n \"/infra/domains/mydomain2\",\n \"/infra/domains/mydomain1\"\n ],\n \"resource_type\": \"PolicyLabel\",\n \"id\": \"my-domains-label\",\n \"display_name\": \"my-domains-label\",\n \"path\": \"/infra/labels/my-domains-label\",\n \"relative_path\": \"my-domains-label\",\n \"parent_path\": \"/infra/labels/my-domains-label\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544641564432,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544641564432,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyLabel"
},
"delete": {
"tags": [
"Policy",
"Infra",
"Labels"
],
"summary": "Delete PolicyLabel object",
"description": "Delete PolicyLabel object",
"operationId": "DeletePolicyLabelForInfra",
"parameters": [
{
"name": "label-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/labels/my-domains-label\n",
"x-vmw-nsx-module": "PolicyLabel"
},
"patch": {
"tags": [
"Policy",
"Infra",
"Labels"
],
"summary": "Patch an existing label object",
"description": "Create label if not exists, otherwise take the partial updates.\nNote, once the label is created type attribute can not be changed.\n",
"operationId": "UpdatePolicyLabelForInfra",
"parameters": [
{
"name": "label-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLabel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/labels/my-domains-label\n{\n \"type\" : \"Domain\",\n \"refs\" : [\"/infra/domains/mydomain1\", \"/infra/domains/mydomain2\"]\n}\n",
"x-vmw-nsx-module": "PolicyLabel",
"x-codegen-request-body-name": "PolicyLabel"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/status": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-1 Gateways"
],
"summary": "Get current status of tier-1 DNS forwarder",
"description": "Get current status of tier-1 DNS forwarder.\n- no enforcement point path specified: Status will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Status will be evaluated only on the given enforcement\npoint.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1DNSForwarderStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateDNSForwarderStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/dns-forwarder/status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyDNSStatistics",
"x-vmw-nsx-example-response": "{\n \"status_per_enforcement_point\": [\n {\n \"resource_type\": \"NsxTDNSForwarderStatus\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"timestamp\": 1537263302625,\n \"status\": \"UP\"\n }\n ],\n \"intent_path\": \"/infra/tier-1s/tier-1/dns-forwarder\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/sites/agents/intelligence/maintenance": {
"get": {
"summary": "Get current status of maintenance mode for Analytics agents",
"description": "Get current status of maintenance mode for Analytics agents",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetAnalyticsAgentMaintenanceMode",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsMaintenanceMode"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy>/policy/api/v1/infra/sites/agents/intelligence/maintenance\n",
"x-vmw-nsx-module": "AnalyticsAgent",
"x-vmw-nsx-example-response": "{\n \"enable\": \"true\",\n}\n"
},
"put": {
"summary": "Activate/deactivate maintenance mode for Analytics agents",
"description": "Activate/deactivate maintenance mode for Analytics agents",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateAnalyticsAgentMaintenanceMode",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsMaintenanceMode"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsMaintenanceMode"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy>/policy/api/v1/infra/sites/agents/intelligence/maintenance\n{\n \"enable\": \"true\",\n}\n",
"x-vmw-nsx-module": "AnalyticsAgent",
"x-vmw-nsx-example-response": "{\n \"enable\": \"true\",\n}\n",
"x-codegen-request-body-name": "AnalyticsMaintenanceMode"
}
},
"/global-infra/tier-1s/{tier-1-id}/dns-forwarder/status": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-1 Gateways"
],
"summary": "Get current status of tier-1 DNS forwarder",
"description": "Get current status of tier-1 DNS forwarder.\n- no enforcement point path specified: Status will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Status will be evaluated only on the given enforcement\npoint.\n",
"operationId": "GlobalInfraGetTier1DNSForwarderStatus",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateDNSForwarderStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/dns-forwarder/status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyDNSStatistics",
"x-vmw-nsx-example-response": "{\n \"status_per_enforcement_point\": [\n {\n \"resource_type\": \"NsxTDNSForwarderStatus\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"timestamp\": 1537263302625,\n \"status\": \"UP\"\n }\n ],\n \"intent_path\": \"/infra/tier-1s/tier-1/dns-forwarder\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Static Routes"
],
"summary": "Read VPC static routes",
"description": "Read VPC static routes",
"operationId": "ReadVpcStaticRoutes",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes/static-route-1\n",
"x-vmw-nsx-module": "PolicyVpcStaticRoutes",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"StaticRoutes\",\n \"id\": \"static-route-1\",\n \"display_name\": \"static-route-1\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes/static-route-1\",\n \"parent_path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1\",\n \"relative_path\": \"static-route-1\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"network\": \"45.1.1.0/24\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516750267338,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516750267338,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Static Routes"
],
"summary": "Create or update a VPC static routes",
"description": "If static routes for route-id are not already present, create\nstatic routes. If it already exists, replace the static routes for route-id.\n",
"operationId": "CreateOrReplaceVpcStaticRoutes",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes/static-route-1\n{\n \"network\": \"45.1.1.0/24\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyVpcStaticRoutes",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"StaticRoutes\",\n \"id\": \"static-route-1\",\n \"display_name\": \"static-route-1\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes/static-route-1\",\n \"parent_path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1\",\n \"relative_path\": \"static-route-1\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"network\": \"45.1.1.0/24\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516750267338,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516750267338,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "StaticRoutes"
},
"delete": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Static Routes"
],
"summary": "Delete VPC static routes",
"description": "Delete VPC static routes",
"operationId": "DeleteVpcStaticRoutes",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes/static-route-1\n",
"x-vmw-nsx-module": "PolicyVpcStaticRoutes",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Static Routes"
],
"summary": "Create or update a VPC static routes",
"description": "If static routes for route-id are not already present, create\nstatic routes. If it already exists, update static routes for route-id.\n",
"operationId": "PatchVpcStaticRoutes",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes/static-route-1\n{\n \"network\": \"45.1.1.0/24\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyVpcStaticRoutes",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "StaticRoutes"
}
},
"/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"NAT",
"Rules",
"Tier-1 Gateways"
],
"summary": "List NAT Rules",
"description": "List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section\ndenoted by <nat-id>.\nUnder tier-1 there will be 3 different NATs(sections).\n(INTERNAL, USER and DEFAULT)\nFor more details related to NAT section please refer to PolicyNAT schema.\nNote:\n IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the\n scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path\n Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.\n",
"operationId": "ListPolicyNatRules",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyNatRuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/vmc_network-demo/nat/USER/nat-rules\n",
"x-vmw-nsx-module": "PolicyNAT",
"x-vmw-nsx-example-response": "{\n\"sort_ascending\": true,\n\"sort_by\": \"display_name\",\n\"result_count\": 3,\n\"results\": [\n {\n \"resource_type\": \"PolicyNatRule\",\n \"description\": \"Example of a NAT rule\",\n \"id\": \"MyNATRule\",\n \"display_name\": \"MyNATRule\",\n \"path\": \"/infra/tier-1s/vmc_network-demo/nat/USER/nat-rules/MyNATRule\",\n \"parent_path\": \"/infra/tier-1s/vmc_network-demo/nat/USER\",\n \"relative_path\": \"MyNATRule\",\n \"sequence_number\": 1,\n \"service\": \"\",\n \"scope\": [],\n \"action\": \"REFLEXIVE\",\n \"enabled\" : true,\n \"logging\" : false,\n \"firewall_match\" : \"MATCH_EXTERNAL_ADDRESS\",\n \"source_network\": \"10.117.5.73\",\n \"translated_network\": \"192.168.1.1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516015559976,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516015559976,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"PolicyNatRule\",\n \"description\": \"Example of a NAT rule\",\n \"id\": \"MyNATRule3\",\n \"display_name\": \"MyNATRule3\",\n \"path\": \"/infra/tier-1s/vmc_network-demo/nat/USER/nat-rules/MyNATRule3\",\n \"parent_path\": \"/infra/tier-1s/vmc_network-demo/nat/USER\",\n \"relative_path\": \"MyNATRule3\",\n \"sequence_number\": 10,\n \"service\": \"/infra/services/AD_Server\",\n \"scope\": [],\n \"action\": \"DNAT\",\n \"enabled\" : true,\n \"logging\" : false,\n \"firewall_match\" : \"MATCH_EXTERNAL_ADDRESS\",\n \"translated_ports\": \"80-82\",\n \"destination_network\": \"10.117.5.19\",\n \"translated_network\": \"192.168.1.1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516084472276,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516084472276,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"PolicyNatRule\",\n \"description\": \"Example of a NAT rule\",\n \"id\": \"MyNATRuleDemo\",\n \"display_name\": \"MyNATRuleDemo\",\n \"path\": \"/infra/tier-1s/vmc_network-demo/nat/USER/nat-rules/MyNATRuleDemo\",\n \"parent_path\": \"/infra/tier-1s/vmc_network-demo/nat/USER\",\n \"relative_path\": \"MyNATRuleDemo\",\n \"sequence_number\": 10,\n \"service\": \"/infra/services/AD_Server\",\n \"scope\": [\n \"infra/tier-0s/tier-0-vmc/interfaces/internet\"\n ],\n \"action\": \"DNAT\",\n \"enabled\" : true,\n \"logging\" : false,\n \"firewall_match\" : \"MATCH_EXTERNAL_ADDRESS\",\n \"translated_ports\": \"80-82\",\n \"destination_network\": \"10.117.5.19\",\n \"translated_network\": \"192.168.1.1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516181809835,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516181809835,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/dhcp-relay-configs": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Relay Configs"
],
"summary": "List DHCP relay config instances",
"description": "Paginated list of all DHCP relay config instances\n",
"operationId": "ListDhcpRelayConfig",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpRelayConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-relay-configs\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"DhcpRelayConfig\",\n \"id\": \"dhcp-relay1\",\n \"display_name\": \"dhcp-relay1\",\n \"path\": \"/infra/dhcp-relay-configs/dhcp-relay1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"dhcp-relay1\",\n \"server_addresses\": [ \"10.1.1.1\", \"10.1.1.2\" ]\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668826912,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668826912,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/logical-switches": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get logical switches that belong to this Group",
"description": "Get logical switches that belong to this Group.\nThis API is applicable for Groups containing Segment member type.\nFor Groups containing other member types, an empty list is returned.\n",
"operationId": "GetGroupLSMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/logical-switches?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n \"id\" : \"20c1ac1f-58b5-4241-a352-f8e82c4a8c65\",\n \"display_name\" : \"LS-HR1\"\n },\n {\n \"id\" : \"c07005fe-4a9a-47f1-9a1e-2db65a285124\",\n \"display_name\" : \"LS-HR2\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/qos-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "List QoS Profiles",
"description": "API will list all QoS profiles.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListQoSProfiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/qos-profiles\n",
"x-vmw-nsx-module": "PolicyQoS",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"QoSProfile\",\n \"id\": \"profile_2\",\n \"display_name\": \"/infra/qos-profiles\",\n \"path\": \"/infra/qos-profiles\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile_2\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353633527,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"State"
],
"summary": "Get tier-1 segment port state",
"description": "Returns tier-1 segment port state on enforcement point\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1SegmentPortState",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/TIER1_DOWNLINK_SWITCH/ports/default:d03f67f8-efd0-491b-955e-82d8323cffa0/state\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"transport_node_ids\": [\n \"01b3242e-a7c8-11ea-9a01-278a0b44b8c9\"\n ],\n \"discovered_bindings\": [\n {\n \"source\": \"VM_TOOLS\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591432722000\n },\n {\n \"source\": \"ARP_SNOOPING\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591853619530\n }\n ],\n \"realized_bindings\": [\n {\n \"source\": \"VM_TOOLS\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591432722000\n },\n {\n \"source\": \"ARP_SNOOPING\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591434843090\n }\n ],\n \"duplicate_bindings\": [],\n \"attachment\": {\n \"id\": \"ef25f3f5-f19a-4aa2-9c6a-842e44d5297b\",\n \"state\": \"ATTACHED\",\n \"attachers\": [\n {\n \"host\": \"01b3242e-a7c8-11ea-9a01-278a0b44b8c9\",\n \"entity\": \"/vmfs/volumes/5edb3cde-ed7a2d43-f9d3-0200637d79e5/32-vm_Client_VM_Ubuntu_1404-local-1700/32-vm_Client_VM_Ubuntu_1404-local-1700.vmx\"\n }\n ]\n }\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/statistics/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tunnels"
],
"summary": "Get policy Tunnel(GRE as of now) statistics summary for given tunnel-id",
"description": "Get policy Tunnel(GRE as of now) statistics summary for given tunnel-id",
"operationId": "getPolicyTunnelStatisticsSummary",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-svc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateTunnelTrafficStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/tunnels/site1-tunnel/statistics/summary\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"destination\": \"44.44.44.10\",\n \"tunnel_policy_path\": \"/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1/tunnels/aa-gre-1\",\n \"traffic_summary\": {\n \"last_update_timestamp\": 1689829077378,\n \"rx\": {\n \"total_bytes\": 1347854,\n \"total_packets\": 25286,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"destination_unsupported_dropped_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"ipv6_dropped_packets\": 0,\n \"kni_dropped_packets\": 0,\n \"l4port_unsupported_dropped_packets\": 0,\n \"malformed_dropped_packets\": 0,\n \"no_receiver_dropped_packets\": 0,\n \"no_route_dropped_packets\": 0,\n \"proto_unsupported_dropped_packets\": 0,\n \"redirect_dropped_packets\": 0,\n \"rpf_check_dropped_packets\": 0,\n \"ttl_exceeded_dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 889401,\n \"total_packets\": 17029,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"dad_dropped_packets\": 0,\n \"frag_needed_dropped_packets\": 0,\n \"ipsec_pol_block_dropped_packets\": 0,\n \"ipsec_pol_err_dropped_packets\": 0,\n \"no_arp_dropped_packets\": 0,\n \"no_linked_dropped_packets\": 0,\n \"no_mem_dropped_packets\": 0,\n \"non_ip_dropped_packets\": 0,\n \"service_insert_dropped_packets\": 0\n }\n },\n \"resource_type\": \"TUNNEL\"\n}\n"
}
},
"/infra/tier-0s/{tier0-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Get Flood Protection Profile Binding Map for Tier-0 Logical Router",
"description": "API will get Flood Protection Profile Binding Map for Tier-0 Logical Router.\n",
"operationId": "GetTier0FloodProtectionProfileBinding",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "flood-protection-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router",
"description": "API will create or update Flood Protection profile binding map for Tier-0 Logical Router.",
"operationId": "UpdateTier0FloodProtectionProfileBinding",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "flood-protection-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\n {\n \"resource_type\":\"FloodProtectionProfileBindingMap\",\n \"profile_path\": \"/infra/flood-protection-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "FloodProtectionProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Delete Flood Protection Profile Binding for Tier-0 Logical Router",
"description": "API will delete Flood Protection Profile Binding for Tier-0 Logical Router.",
"operationId": "DeleteTier0FloodProtectionProfileBinding",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "flood-protection-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router",
"description": "API will create or update Flood Protection profile binding map for Tier-0 Logical Router.",
"operationId": "PatchTier0FloodProtectionProfileBindingMap",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "flood-protection-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\n {\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"profile_path\": \"/infra/flood-protection-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-codegen-request-body-name": "FloodProtectionProfileBindingMap"
}
},
"/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "List Infra Segment Discovery Profile Binding Maps",
"description": "API will list all Infra Segment Discovery Profile Binding Maps in current segment id.\n",
"operationId": "ListInfraSegmentDiscoveryBindings",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/dhcp-server-configs/{config-id}/stats": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Read DHCP server statistics",
"description": "Read DHCP server statistics",
"operationId": "GlobalInfraReadDhcpServerStats",
"parameters": [
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServerStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/stats?connectivity_path=/infra/tier-1s/it_t1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"dhcp_server_id\": \"0c660543-5edf-463a-ace8-bec9b9651d02\",\n \"timestamp\": 1578798980607,\n \"discovers\": 0,\n \"offers\": 0,\n \"requests\": 0,\n \"acks\": 0,\n \"nacks\": 0,\n \"declines\": 0,\n \"releases\": 0,\n \"informs\": 0,\n \"errors\": 0\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Get IPSec VPN local endpoint",
"description": "Get IPSec VPN local endpoint for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Create or fully replace IPSec VPN local endpoint",
"description": "Create or fully replace IPSec VPN local endpoint\nfor a given ipsec vpn service under Tier-1.\nRevision is optional for creation and required for update.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdateTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n{\n \"resource_type\": \"IPSecVpnLocalEndpoint\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_revision\": 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnLocalEndpoint"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Delete IPSec VPN local endpoint",
"description": "Delete IPSec VPN local endpoint for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Create or patch a custom IPSec VPN local endpoint",
"description": "Create or patch a custom IPSec VPN local endpoint for a given ipsec vpn service under Tier-1.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrPatchTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\"\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnLocalEndpoint"
}
},
"/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Read IDS rule",
"description": "Read IDS rule",
"operationId": "ReadIdsGatewayRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/intrusion-service-gateway-policies/default/rules/entry1\n",
"x-vmw-nsx-module": "PolicyIDSGateway",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IdsRule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/intrusion-service-gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/intrusion-service-gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-1s/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-1s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Create or Update IDS gateway rule",
"description": "Create or Update the IDS gateway rule.\n",
"operationId": "CreateOrReplaceIdsGatewayRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/intrusion-service-gateway-policies/default/rules/entry1\n{\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"services\": [\"/infra/services/HTTP\"],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-1s/vmc\"\n ],\n \"action\":\"ALLOW\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyIDSGateway",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IdsRule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/intrusion-service-gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/intrusion-service-gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-1s/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-1s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "IdsRule"
},
"delete": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Delete IDS Gateway rule",
"description": "Delete IDS Gateway rule",
"operationId": "DeleteIdsGatewayRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/intrusion-service-gateway-policies/default/rules/entry1\n",
"x-vmw-nsx-module": "PolicyIDSGateway"
},
"patch": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Update IDS gateway rule",
"description": "Update the gateway rule.\n",
"operationId": "PatchIdsGatewayRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/intrusion-service-gateway-policies/default/rules/entry1\n{\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"services\": [\"/infra/services/HTTP\"],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-1s/vmc\"\n ],\n \"action\":\"ALLOW\"\n}\n",
"x-vmw-nsx-module": "PolicyIDSGateway",
"x-codegen-request-body-name": "IdsRule"
}
},
"/infra/livetraces/statuses": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Livetrace"
],
"summary": "List livetrace status entities",
"description": "Get a list of all livetrace status entities.",
"operationId": "ListLiveTraceStatus",
"parameters": [
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiveTraceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"source_lport\": \"/infra/segments/lta_test/ports/default:d9279792-b2d2-4161-97fe-b2b5717b4d16\",\n \"operation_state\": \"FINISHED\",\n \"timeout\": 10,\n \"actions\": {\n \"trace_config\": {\n \"action_argument\": {\n \"trace_type\": \"UNI_DIRECTIONAL\"\n },\n \"sampling_argument\": {\n \"match_number\": 10,\n \"sampling_type\": \"FirstNSampling\"\n }\n },\n \"pktcap_config\": {\n \"action_argument\": {\n \"pktcap_type\": \"UNI_DIRECTIONAL\"\n },\n \"sampling_argument\": {\n \"match_number\": 10,\n \"sampling_type\": \"FirstNSampling\"\n }\n }\n },\n \"request_status\": \"SUCCESS_DELIVERED\",\n \"filter_invalid_info\": [\n {}\n ],\n \"id\": \"/infra/livetraces/x6\",\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"source_lport\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/dhcp-server-configs/{config-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Read DHCP server state",
"description": "Read DHCP server state",
"operationId": "GlobalInfraReadDhcpServerState",
"parameters": [
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServerState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/state?connectivity_path=/infra/tier-1s/it_t1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"details\": [\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"fe651e63-04bd-43a4-a8ec-45381a3b71b9\",\n \"state\": \"in_progress\",\n \"failure_message\": \"CCP Id:ab5958df-d98a-468e-a72b-d89dcdae5346, Message:State realization is in progress at the node.\"\n },\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"ebe174ac-e4f1-4135-ba72-3dd2eb7099e3\",\n \"state\": \"in_sync\"\n }\n ],\n \"state\": \"in_progress\",\n \"failure_message\": \"The state realization is in progress at transport nodes.\"\n}\n"
}
},
"/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies"
],
"summary": "Read rule",
"description": "Read rule",
"operationId": "ReadForwardingRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "forwarding-policy-id",
"in": "path",
"description": "Forwarding map id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1/rules/rule-1\n",
"x-vmw-nsx-module": "PolicyForwarding",
"x-vmw-nsx-example-response": "{\n\"resource_type\": \"ForwardingRule\",\n\"description\": \"s3 rule\",\n\"id\": \"rule-1\",\n\"display_name\": \"rule-1\",\n\"action\":\"FORWARD_TO_UNDERLAY\",\n\"tags\": [],\n\"path\": \"/infra/domains/domain1/forwarding-policies/forwarding-policy-1000/rules/forwarding-rule-1\",\n\"relative_path\": \"rule-1\",\n\"sequence_number\": 0,\n\"source_groups\": [\n \"/infra/domains/domain1/groups/srcgrp\"\n],\n\"services\": [\n \"ANY\"\n ],\n\"logged\": false,\n\"destination_groups\": [\n \"/infra/domains/default/groups/S3\"\n],\n\"_create_user\": \"admin\",\n\"_create_time\": 1509362026134,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1509362026135,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies"
],
"summary": "Update forwarding rule",
"description": "Create a rule with the rule-id is not already present,\notherwise update the rule.\nPerformance Note: If you want to edit several rules in a forwarding policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>\n",
"operationId": "CreateOrUpdateForwardingRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "forwarding-policy-id",
"in": "path",
"description": "Forwarding map id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "rule id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1\n/rules/forwarding-rule-1\n{\n\"resource_type\": \"ForwardingRule\",\n\"description\": \"s3 rule\",\n\"id\": \"rule-1\",\n\"display_name\": \"rule-1\",\n\"action\":\"FORWARD_TO_UNDERLAY\",\n\"tags\": [],\n\"path\": \"/infra/domains/domain1/forwarding-policies/forwarding-policy-1000/rules/forwarding-rule-1\",\n\"relative_path\": \"rule-1\",\n\"sequence_number\": 0,\n\"source_groups\": [\n \"/infra/domains/domain1/groups/srcgrp\"\n],\n\"services\": [\n \"ANY\"\n ],\n\"logged\": false,\n\"destination_groups\": [\n \"/infra/domains/default/groups/S3\"\n],\n\"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyForwarding",
"x-vmw-nsx-example-response": "{\n\"resource_type\": \"ForwardingRule\",\n\"description\": \"s3 rule\",\n\"id\": \"rule-1\",\n\"display_name\": \"rule-1\",\n\"action\":\"FORWARD_TO_UNDERLAY\",\n\"tags\": [],\n\"path\": \"/infra/domains/domain1/forwarding-policies/forwarding-policy-1000/rules/forwarding-rule-1\",\n\"relative_path\": \"rule-1\",\n\"sequence_number\": 0,\n\"source_groups\": [\n \"/infra/domains/domain1/groups/srcgrp\"\n],\n\"services\": [\n \"ANY\"\n ],\n\"logged\": false,\n\"destination_groups\": [\n \"/infra/domains/default/groups/S3\"\n],\n\"_create_user\": \"admin\",\n\"_create_time\": 1509362026134,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1509362026135,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1\n}\n",
"x-codegen-request-body-name": "ForwardingRule"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies"
],
"summary": "Delete ForwardingRule",
"description": "Delete ForwardingRule",
"operationId": "DeleteForwardingRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "forwarding-policy-id",
"in": "path",
"description": "Forwarding Map ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "ForwardingRule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1/rules/rule-1\n",
"x-vmw-nsx-module": "PolicyForwarding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies"
],
"summary": "Update forwarding rule",
"description": "Create a rule with the rule-id is not already present,\notherwise update the rule.\nPerformance Note: If you want to edit several rules in a forwarding policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>\n",
"operationId": "PatchForwardingRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "forwarding-policy-id",
"in": "path",
"description": "Forwarding map id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1\n/rules/forwarding-rule-1\n{\n\"resource_type\": \"ForwardingRule\",\n\"description\": \"s3 rule\",\n\"id\": \"rule-1\",\n\"display_name\": \"rule-1\",\n\"action\":\"FORWARD_TO_UNDERLAY\",\n\"tags\": [],\n\"path\": \"/infra/domains/domain1/forwarding-policies/forwarding-policy-1000/rules/forwarding-rule-1\",\n\"relative_path\": \"rule-1\",\n\"sequence_number\": 0,\n\"source_groups\": [\n \"/infra/domains/domain1/groups/srcgrp\"\n],\n\"services\": [\n \"ANY\"\n ],\n\"logged\": false,\n\"destination_groups\": [\n \"/infra/domains/default/groups/S3\"\n]\n}\n",
"x-vmw-nsx-module": "PolicyForwarding",
"x-codegen-request-body-name": "ForwardingRule"
}
},
"/eula/acceptance": {
"get": {
"tags": [
"System Administration",
"Settings",
"Licenses"
],
"summary": "Return the acceptance status of end user license agreement\n",
"description": "Return the acceptance status of end user license agreement\n",
"operationId": "GetEULAAcceptance",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EULAAcceptance"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/eula/acceptance\n",
"x-vmw-nsx-module": "EULA",
"x-vmw-nsx-example-response": "{\n \"acceptance\": false\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "List Segment QoS Profile Binding Maps",
"description": "API will list all Segment QoS Profile Binding Maps in current segment id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListInfraSegmentQoSBindings",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/segment-qos-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/segments/segment_1/segment-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/cloud-native-service-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given Cloud Native Service Instance is a member",
"description": "Get policy groups for which the given Cloud Native Service Instance is a member.\n",
"operationId": "GetGroupsForCloudNativeServiceInstance",
"parameters": [
{
"name": "cns_external_id",
"in": "query",
"description": "Cloud Native Service external ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/cloud-native-service-group-associations?cns_external_id=564de333-15ac-de52-da90-974fe099a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Get L2VPN service list result under Tier-1",
"description": "Get paginated list of all L2VPN services under Tier-1.\n\n
\nThis API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services> instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n",
"operationId": "ListTier1L2VPNServices",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services/default/l2vpn-services\n",
"x-vmw-nsx-module": "PolicyLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-1s/cgw/locale-services/default/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/global-infra/domains/{domain-id}/gateway-policies": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "List gateway policies",
"description": "List all gateway policies for specified Domain.",
"operationId": "GlobalInfraListGatewayPoliciesForDomain",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"default\",\n \"display_name\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"default\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 50000,\n \"category\": \"LocalGatewayRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061800,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 6\n },\n {\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"internal\",\n \"display_name\": \"internal\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/internal\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"internal\",\n \"sequence_number\": 100,\n \"internal_sequence_number\": 20100,\n \"category\": \"SharedPreRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469778,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516295469778,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/dhcp-relay-configs": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Relay Configs"
],
"summary": "List DHCP relay config instances",
"description": "Paginated list of all DHCP relay config instances\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListDhcpRelayConfig",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpRelayConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-relay-configs\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"DhcpRelayConfig\",\n \"id\": \"dhcp-relay1\",\n \"display_name\": \"dhcp-relay1\",\n \"path\": \"/infra/dhcp-relay-configs/dhcp-relay1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"dhcp-relay1\",\n \"server_addresses\": [ \"10.1.1.1\", \"10.1.1.2\" ]\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668826912,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668826912,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/physical-server-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given Physical Server is a member",
"description": "Get policy groups for which the given Physical Server is a member.\n",
"operationId": "GlobalInfraGetGroupsForPhysicalServer",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "physical_server_external_id",
"in": "query",
"description": "Physical external ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/physical-server-group-associations?physical_server_external_id=564de333-15ac-de52-da90-974fe099a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"BGP"
],
"summary": "Get BGP neighbor status for the Tier0",
"description": "Returns the status of all the BGP neighbors for the given Tier0.\nTo get BGP neighbor status for a particular enforcement point,\nparameter \"enforcement_point_path=<enforcement_point_path>\" needs to be specified.\nIf an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched.\nTo get BGP neighbors status for the logical router from particular edge node,\nparameter \"edge_path=<edge_path>\" needs to be specified.\nIf an edge_path is unspecified, then bgp neighbor status for all edges is fetched.\n",
"operationId": "GetTier0BgpNeighborsStatus",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyBgpNeighborsStatusListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/defalt/bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"cursor\": \"00361b9f1d54-2f05-441e-9851-c42518cc8b1dasdfds\",\n \"sort_ascending\": true,\n \"sort_by\": \"displayName\",\n \"result_count\": 1,\n \"tier0_path\": \"/infra/sites/default/enforcement-points/default\",\n \"results\": [{\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\",\n \"source_address\": \"10.1.1.1\",\n \"neighbor_address\": \"10.1.2.1\",\n \"remote_as_number\": \"1\",\n \"remote_port\": 179,\n \"local_port\": 179,\n \"connection_status\": \"CONNECTED\",\n \"messages_received\": 12,\n \"messages_sent\": 10,\n \"connection_drop_count\": 0,\n \"hold_time\": 180,\n \"keep_alive_time\": 30,\n \"graceful_restart\": true,\n \"last_updated_timestamp\": 11999191991991\n }]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Get IPSec VPN Session",
"description": "Get IPSec VPN session without sensitive data for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "GetTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyBasedIPSecVpnSession\",\n \"description\": \"Policy based vpn session 1\",\n \"display_name\": \"pbs-1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"rules\" : [ {\n \"resource_type\": \"IPSecVpnRule\",\n \"id\": \"custom-rule-1\",\n \"path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1/rules/custom-rule-1\",\n \"parent_path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\",\n \"relative_path\": \"custom-rule-1\",\n \"sources\": [\n {\n \"subnet\" : \"10.0.2.0/24\"\n },\n {\n \"subnet\" : \"10.0.1.0/24\"\n }\n ],\n \"destinations\" : [\n {\n \"subnet\" : \"10.1.1.0/24\"\n }\n ],\n \"enabled\" : true,\n \"logged\" : true,\n \"action\": \"PROTECT\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n } ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Create or fully replace IPSec VPN session",
"description": "Create or fully replace IPSec VPN session for a ipsec vpn\nservice under Tier-1.\nRevision is optional for creation and required for update.\n",
"operationId": "CreateOrUpdateTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1\n{\n \"resource_type\": \"RouteBasedIPSecVpnSession\",\n \"display_name\" : \"rbs-1\",\n \"description\" : \"Route based vpn session 1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"psk\" : \"test\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"tunnel_interfaces\" : [ {\n \"ip_subnets\" : [ {\n \"ip_addresses\" : [ \"169.90.50.1\" ],\n \"prefix_length\" : 30\n } ],\n \"_revision\" : 2,\n } ],\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"RouteBasedIPSecVpnSession\",\n \"display_name\" : \"rbs-1\",\n \"description\" : \"Route based vpn session 1\",\n \"path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1\",\n \"parent_path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default\",\n \"relative_path\": \"rbs-1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"psk\" : \"test\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"tunnel_interfaces\" : [ {\n \"resource_type\" : \"IPSecVpnTunnelInterface\",\n \"path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1/interfaces/default-tunnel-interface\",\n \"parent_path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1\",\n \"relative_path\": \"default-tunnel-interface\",\n \"ip_subnets\" : [ {\n \"ip_addresses\" : [ \"169.90.50.1\" ],\n \"prefix_length\" : 30\n } ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 2,\n } ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 0\n}\n",
"x-codegen-request-body-name": "IPSecVpnSession"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Delete IPSec VPN session",
"description": "Delete IPSec VPN session for a given ipsec-vpn service under Tier-1.",
"operationId": "DeleteTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Create or patch an IPSec VPN session",
"description": "Create or patch an IPSec VPN session for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "CreateOrPatchTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\n{\n \"resource_type\": \"PolicyBasedIPSecVpnSession\",\n \"description\": \"Policy based vpn session 1\",\n \"display_name\": \"pbs-1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"psk\" : \"test\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"rules\" : [ {\n \"resource_type\": \"IPSecVpnRule\",\n \"id\": \"custom-rule-1\",\n \"sources\": [\n {\n \"subnet\" : \"10.0.2.0/24\"\n },\n {\n \"subnet\" : \"10.0.1.0/24\"\n }\n ],\n \"destinations\" : [\n {\n \"subnet\" : \"10.1.1.0/24\"\n }\n ],\n \"enabled\" : true,\n \"logged\" : true,\n \"action\": \"PROTECT\"\n } ]\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnSession"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tunnels"
],
"summary": "Get policy Tunnel(GRE as of now) status for given tunnel-id",
"description": "Get policy Tunnel(GRE as of now) status for given tunnel-id",
"operationId": "getPolicyTunnelStatus",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-svc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/tunnels/site1-tunnel/status\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"destination\": \"44.44.44.10\",\n \"endpoint_status_per_edge_node\": [\n {\n \"last_update_timestamp\": 1689829155850,\n \"source\": \"40.40.40.1\",\n \"tunnel_port_id\": \"4aaaf496-e99d-41f6-8d67-f9a919210eb6\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/0\",\n \"runtime_status\": \"UP\",\n \"tunnel_up_count\": 0,\n \"tunnel_last_up_time\": 0,\n \"tunnel_down_count\": 0,\n \"tunnel_last_down_time\": 0,\n \"keepalive_status\": \"KEEPALIVE_STATUS_DISABLED\",\n \"keepalive_interval\": 10,\n \"keepalive_dead_multiplier\": 3,\n \"keepalive_tx_count\": 0,\n \"keepalive_last_tx_time\": 0,\n \"keepalive_rx_count\": 0,\n \"keepalive_last_rx_time\": 0,\n \"keepalive_ack\": \"KEEPALIVE_STATUS_ENABLED\",\n \"keepalive_ack_sent_count\": 0,\n \"keepalive_last_ack_time\": 0,\n \"keepalive_admin_state\": \"DISABLED\"\n },\n {\n \"last_update_timestamp\": 1689829155915,\n \"source\": \"40.40.40.2\",\n \"tunnel_port_id\": \"418c4d6f-9061-4460-b374-f9a7a74c94de\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/1\",\n \"runtime_status\": \"UP\",\n \"tunnel_up_count\": 0,\n \"tunnel_last_up_time\": 0,\n \"tunnel_down_count\": 0,\n \"tunnel_last_down_time\": 0,\n \"keepalive_status\": \"KEEPALIVE_STATUS_DISABLED\",\n \"keepalive_interval\": 10,\n \"keepalive_dead_multiplier\": 3,\n \"keepalive_tx_count\": 0,\n \"keepalive_last_tx_time\": 0,\n \"keepalive_rx_count\": 0,\n \"keepalive_last_rx_time\": 0,\n \"keepalive_ack\": \"KEEPALIVE_STATUS_ENABLED\",\n \"keepalive_ack_sent_count\": 0,\n \"keepalive_last_ack_time\": 0,\n \"keepalive_admin_state\": \"DISABLED\"\n }\n ],\n \"resource_type\": \"TUNNEL\"\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/ipsec-vpn-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Get IPSec VPN service list result",
"description": "Get paginated list of all IPSec VPN services\nunder Tier-1.\n",
"operationId": "ListTier1VpnIPSecVpnServices",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"IPSecVpnService\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default\",\n \"enabled\" : false,\n \"bypass_rules\" : [],\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/global-infra/dhcp-server-configs/{dhcp-server-config-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Read DHCP server configuration",
"description": "Read DHCP server configuration",
"operationId": "GlobalInfraReadDhcpServerConfig",
"parameters": [
{
"name": "dhcp-server-config-id",
"in": "path",
"description": "DHCP server config ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServerConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/dhcp-srv1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"DhcpServerConfig\",\n \"id\": \"dhcp-srv1\",\n \"display_name\": \"dhcp-srv1\",\n \"path\": \"/infra/dhcp-server-configs/dhcp-srv1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"dhcp-srv1\",\n \"server_address\": \"10.1.1.1/30\",\n \"lease_time\": 10000,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668826912,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668826912,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/realized-state/enforcement-points/{enforcement-point-name}/firewalls/firewall-sections/{firewall-section-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "Read Firewall",
"description": "Read a Firewall and the complete tree underneath. Returns the\npopulated Firewall object.\n",
"operationId": "ReadFirewallSectionRealizedState",
"parameters": [
{
"name": "enforcement-point-name",
"in": "path",
"description": "Enforcement Point Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-section-id",
"in": "path",
"description": "Firewall Section Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealizedFirewallSection"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyRealizedState"
}
},
"/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Get IPSec VPN configuration for the peer site",
"description": "Download IPSec VPN configuration for the peer site. Peer config also\ncontains PSK; be careful when sharing or storing it.\n",
"operationId": "GetTier0VpnIPSecVpnPeerConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/rbs-1/peer-config\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "# Suggestive peer configuration for Policy IPSec VPN\n#\n# IPSec VPN path : /infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/rbs-1/peer-config\n# IPSec VPN name : rbs-1\n# IPSec VPN description :\n# Tier 0 path : /infra/tier-0s/ext_net\n\n\n#\n# Enforcement point path : /infra/deployment-zones/default/enforcement-points/nsxt\n# Enforcement point type : NSXT\n#\n# Suggestive peer configuration for IPSec VPN Connection\n#\n# IPSecVPNSession Id : aafeb845-e2fa-4c86-9f0e-43c5ed3ef707\n# IPSecVPNSession name : PROVIDER.ext_net.pa-paris-rb-vpn\n# IPSecVPNSession description:\n# IPSecVPNSession enabled : true\n# IPSecVPNSession type : Route based VPN\n# Logical router Id : d58beabb-853c-473c-ad8d-34bd9c644692\n# Generated Time : Tue Apr 03 14:21:13 GMT 2018\n\n#\n# Internet Key Exchange Configuration [Phase 1]\n# Configure the IKE SA as outlined below\nIKE version : IKE_V2\nConnection initiation mode : INITIATOR\nAuthentication method : PSK\nPre shared key : 12345\nAuthentication algorithm : [SHA2_256]\nEncryption algorithm : [AES_128]\nSA life time : 86400\nNegotiation mode : Not applicable for ikev2\nDH group : [GROUP14]\n\n# IPsec_configuration [Phase 2]\n# Configure the IPsec SA as outlined below\nTransform Protocol : ESP\nAuthentication algorithm : []\nSa life time : 3600\nEncryption algorithm : [AES_GCM_128]\nEncapsulation mode : TUNNEL_MODE\nEnable perfect forward secrecy : true\nPerfect forward secrecy DH group: [GROUP14]\n\n# IPsec Dead Peer Detection (DPD) settings\nDPD enabled : true\nDPD probe interval : 60\n\n# Peer configuration\nPeer address : 88.88.72.22 # Peer gateway public IP.\nPeer id : 88.88.72.22\nPeer Subnet : 0.0.0.0/0\n\n# Local configuration\nLocal address : 44.44.44.46 # Local gateway public IP.\nLocal id : 99.33.33.33\nLocal Subnet : 0.0.0.0/0\n\n# Virtual Tunnel Interface\nPeer VTI address : 192.168.2.1\nLocal VTI address : 192.168.2.11\nTunnel Interface MTU : 1416 bytes\n\n#\n# BGP Configuration\n#\nBGP neighbour IP : 192.168.2.1\nBGP neighbour AS number : 2000\nBGP local IP : 192.168.2.11\nBGP local AS number : 65556\nBGP secret : PolicyRocks\nBGP hold down timer : 180\nBGP keep alive timer : 60\nBFD Status : false\n"
}
},
"/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "List Infra Port Monitoring Profile Binding Maps",
"description": "API will list all Infra Port Monitoring Profile Binding Maps in current port id.\n",
"operationId": "ListInfraPortMonitoringBindings",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortMonitoringProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-monitoring-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortMonitoringProfileBindingMap\",\n \"description\": \"\",\n \"name\":\"1\",\n \"id\":\"1\",\n \"display_name\": \"PortMonitoringProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-monitoring-profile-binding-maps/1\",\n \"relative_path\": \"PortMonitoringProfileBindingMaps\",\n \"port_mirroring_profile_path\":\"/infra/port-mirroring-profiles/1\",\n \"ipfix_l2_profile_path\":\"/infra/ipfix-l2-profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Get Group discovery profile binding map",
"description": "API will get Group discovery profile binding map",
"operationId": "GetGroupDiscoveryProfileBinding",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "discovery-profile-binding-map-id",
"in": "path",
"description": "Group discovery profile binding map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/groups/group1/discovery-profile-binding-maps/bm1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sequence_number\": 22,\n \"resource_type\": \"GroupDiscoveryProfileBindingMap\",\n \"id\": \"bm1\",\n \"display_name\": \"bm1\",\n \"path\": \"/infra/domains/default/groups/group1/discovery-profile-binding-maps/bm1\",\n \"relative_path\": \"bm1\",\n \"parent_path\": \"/infra/domains/default/groups/group1\",\n \"unique_id\": \"35230872-f823-4c53-ab1a-5f8e06558bdc\",\n \"marked_for_delete\": false,\n \"profile_path\": \"/infra/ip-discovery-profiles/p2\",\n \"_last_modified_time\": 1570048887730,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1570048887730,\n \"_last_modified_user\": \"admin\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Update Group discovery profile binding map",
"description": "API will update Group discovery profile binding map",
"operationId": "UpdateGroupDiscoveryProfileBinding",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "discovery-profile-binding-map-id",
"in": "path",
"description": "Group discovery profile binding map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/default/groups/group1/discovery-profile-binding-maps/bm1\n{\n \"profile_path\": \"/infra/ip-discovery-profiles/p3\",\n \"sequence_number\": 22\n}\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sequence_number\": 22,\n \"resource_type\": \"GroupDiscoveryProfileBindingMap\",\n \"id\": \"bm1\",\n \"display_name\": \"bm1\",\n \"path\": \"/infra/domains/default/groups/group1/discovery-profile-binding-maps/bm1\",\n \"relative_path\": \"bm1\",\n \"parent_path\": \"/infra/domains/default/groups/group1\",\n \"unique_id\": \"35230872-f823-4c53-ab1a-5f8e06558bdc\",\n \"marked_for_delete\": false,\n \"profile_path\": \"/infra/ip-discovery-profiles/p2\",\n \"_last_modified_time\": 1570048887730,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1570048887730,\n \"_last_modified_user\": \"admin\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "GroupDiscoveryProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Delete Group discovery profile binding map",
"description": "API will delete Group discovery profile binding map",
"operationId": "DeleteGroupDiscoveryProfileBinding",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "discovery-profile-binding-map-id",
"in": "path",
"description": "Group discovery profile binding map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/default/groups/group1/discovery-profile-binding-maps/bm1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Create or update Group discovery profile binding map",
"description": "API will create or update Group discovery profile binding map",
"operationId": "PatchGroupDiscoveryProfileBinding",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "discovery-profile-binding-map-id",
"in": "path",
"description": "Group discovery profile binding map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/default/groups/group1/discovery-profile-binding-maps/bm1\n{\n \"profile_path\": \"/infra/ip-discovery-profiles/p3\",\n \"sequence_number\": 22\n}\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "GroupDiscoveryProfileBindingMap"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}?action=full-sync": {
"post": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "Full sync EnforcementPoint from Site",
"description": "Full sync EnforcementPoint from Site",
"operationId": "FullSyncEnforcementPointForSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/external-ep?action=full-sync\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement"
}
},
"/global-infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "List Firewall CPU Memory Thresholds Profile Binding Maps",
"description": "API will list all Firewall CPU Memory Thresholds Profile Binding Maps.\n",
"operationId": "GlobalInfraListPolicyFirewallCPUMemThresholdsProfileBindingMaps",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCPUMemThresholdsProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyFirewallCPUMemThresholdsProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMap\",\n \"id\" : \"1\",\n \"display_name\" : \"binding-map-1\",\n \"path\" : \"/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/1\",\n \"relative_path\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMaps\",\n \"profile_path\" : \"/infra/firewall-cpu-mem-thresholds-profiles/1\",\n \"transport_nodes\" : [{\n \"target_id\": \"f4af8b57-8957-3c00-8ce9-105b25609bd6\",\n \"target_type\": \"TransportNode\"\n }]\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/dns-forwarder-zones/{dns-forwarder-zone-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"DNS Zones"
],
"summary": "Read the DNS Forwarder Zone",
"description": "Read the DNS Forwarder Zone",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadPolicyDnsForwarderZone",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dns-forwarder-zone-id",
"in": "path",
"description": "DNS Forwarder Zone ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarderZone"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dns-forwarder-zones/conditional-1\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyDnsForwarderZone\",\n \"id\" : \"conditional-1\",\n \"display_name\" : \"$1\",\n \"path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"parent_path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"relative_path\" : \"conditional-1\",\n \"dns_domain_names\" : [ \"foo.com\" ],\n \"upstream_servers\" : [ \"1.1.1.1\", \"2.2.2.2\" ],\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517400132921,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517400132921,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"DNS Zones"
],
"summary": "Create or update the DNS Forwarder Zone",
"description": "Create or update the DNS Forwarder Zone",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdatePolicyDnsForwarderZone",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dns-forwarder-zone-id",
"in": "path",
"description": "DNS Forwarder Zone ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarderZone"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarderZone"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/dns-forwarder-zones/conditional-1\n{\n \"display_name\" : \"Conditional 1\",\n \"dns_domain_names\" : [ \"foo.com\" ],\n \"upstream_servers\" : [ \"1.1.1.1\", \"2.2.2.2\" ],\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyDnsForwarderZone\",\n \"id\" : \"conditional-1\",\n \"display_name\" : \"$1\",\n \"path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"parent_path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"relative_path\" : \"conditional-1\",\n \"dns_domain_names\" : [ \"foo.com\" ],\n \"upstream_servers\" : [ \"1.1.1.1\", \"2.2.2.2\" ],\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517400132921,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517400132921,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n",
"x-codegen-request-body-name": "PolicyDnsForwarderZone"
},
"delete": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"DNS Zones"
],
"summary": "Delete the DNS Forwarder Zone",
"description": "Delete the DNS Forwarder Zone",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeletePolicyDnsForwarderZone",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dns-forwarder-zone-id",
"in": "path",
"description": "DNS Forwarder Zone ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/dns-forwarder-zones/conditional-1\n",
"x-vmw-nsx-module": "PolicyDnsForwarder"
},
"patch": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"DNS Zones"
],
"summary": "Create or update the DNS Forwarder Zone",
"description": "Create or update the DNS Forwarder Zone",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchPolicyDnsForwarderZone",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dns-forwarder-zone-id",
"in": "path",
"description": "DNS Forwarder Zone ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarderZone"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/dns-forwarder-zones/conditional-1\n{\n \"display_name\" : \"Conditional 1\",\n \"dns_domain_names\" : [ \"foo.com\" ],\n \"upstream_servers\" : [ \"1.1.1.1\", \"2.2.2.2\" ]\n}\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-codegen-request-body-name": "PolicyDnsForwarderZone"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "List Infra Segment Discovery Profile Binding Maps",
"description": "API will list all Infra Segment Discovery Profile Binding Maps in current segment id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListInfraSegmentDiscoveryBindings",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/settings/firewall/idfw/transport-nodes/{transport-node-id}/vms/status": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "List IDFW status of VMs by transport node id",
"description": "This API will list all VMs and statuses based on transport node ID of idfw\nenabled compute collection.\n",
"operationId": "ListVirtualMachineIDFWStatusByTransportNode",
"parameters": [
{
"name": "transport-node-id",
"in": "path",
"description": "Transport node id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdfwVirtualMachineStatusListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-ip>/policy/api/v1/infra/settings/firewall/idfw/transport-nodes/<transport-node-id>/vms/status\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"vm_id\": \"52e03984-673f-bb95-ce4c-820247a9c388\",\n \"vm_status\": [\n {\n \"status\": \"UP\"\n },\n {\n \"status\": \"IDFW_ENABLED\"\n }\n ]\n },\n {\n \"vm_id\": \"501ae88d-bf57-0c5f-ac67-54ee37f2a111\",\n \"vm_status\": [\n {\n \"status\": \"UP\"\n },\n {\n \"status\": \"IDFW_ENABLED\"\n }\n ]\n },\n {\n \"vm_id\": \"5286c272-27a3-f62f-96ca-57b96163456e\",\n \"vm_status\": [\n {\n \"status\": \"UP\"\n },\n {\n \"status\": \"IDFW_ENABLED\"\n }\n ]\n },\n {\n \"vm_id\": \"501ada68-57b5-8b84-788a-fe7dc34e3ffb\",\n \"vm_status\": [\n {\n \"status\": \"UP\"\n },\n {\n \"status\": \"IDFW_ENABLED\"\n }\n ]\n },\n {\n \"vm_id\": \"501a8541-a9a1-d246-bf91-122c6ed45307\",\n \"vm_status\": [\n {\n \"status\": \"UP\"\n },\n {\n \"status\": \"IDFW_ENABLED\"\n }\n ]\n },\n {\n \"vm_id\": \"5284ecaa-204a-cf30-823e-9e2f757ba407\",\n \"vm_status\": [\n {\n \"status\": \"UP\"\n },\n {\n \"status\": \"IDFW_ENABLED\"\n }\n ]\n }\n ],\n \"result_count\": 6\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/arp-proxies": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"ARP Proxies"
],
"summary": "Get Tier-1 Address Resolution Protocol Proxies",
"description": "Returns ARP proxy table for a tier-1\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1GatewayArpProxies",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s/pepsi/arp-proxies\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/host-transport-node-profiles": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Profiles",
"Host Transport Node Profiles"
],
"summary": "List Host Transport Nodes",
"description": "Returns information about all host transport node profiles.\n",
"operationId": "ListPolicyHostTransportNodeProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyHostTransportNodeProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/host-transport-node-profiles\n",
"x-vmw-nsx-module": "PolicyHostTransportNodeProfile",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"host_switch_spec\": {\n \"host_switches\": [\n {\n \"host_switch_name\": \"DSwitch2\",\n \"host_switch_id\": \"50 34 30 8b c9 77 64 57-1e 89 55 24 bd 32 70 e6\",\n \"host_switch_type\": \"VDS\",\n \"host_switch_mode\": \"STANDARD\",\n \"host_switch_profile_ids\": [\n {\n \"key\": \"UplinkHostSwitchProfile\",\n \"value\": \"/infra/host-switch-profiles/b7b04576-a249-4842-b21d-59a65ae51ec5\"\n }\n ],\n \"uplinks\": [\n {\n \"vds_uplink_name\": \"Uplink 1\",\n \"uplink_name\": \"uplink-1\"\n },\n {\n \"vds_uplink_name\": \"Uplink 2\",\n \"uplink_name\": \"uplink-2\"\n },\n {\n \"vds_uplink_name\": \"Uplink 3\",\n \"uplink_name\": \"uplink-3\"\n },\n {\n \"vds_uplink_name\": \"Uplink 4\",\n \"uplink_name\": \"uplink-4\"\n }\n ],\n \"is_migrate_pnics\": false,\n \"ip_assignment_spec\": {\n \"resource_type\": \"AssignedByDhcp\"\n },\n \"cpu_config\": [],\n \"transport_zone_endpoints\": [\n {\n \"transport_zone_id\": \"/infra/sites/default/enforcement-points/default/transport-zones/f82d3923-ce47-419c-8f39-71ef39d47426\",\n \"transport_zone_profile_ids\": []\n },\n {\n \"transport_zone_id\": \"/infra/sites/default/enforcement-points/default/transport-zones/7cd1b7b6-f1c4-46a1-93a8-8b60ea95e673\",\n \"transport_zone_profile_ids\": []\n }\n ],\n \"not_ready\": false\n }\n ],\n \"resource_type\": \"StandardHostSwitchSpec\"\n },\n \"ignore_overridden_hosts\": false,\n \"resource_type\": \"PolicyHostTransportNodeProfile\",\n \"id\": \"b065cc94-f2c2-4a21-9fad-9ea86c185eae\",\n \"display_name\": \"tnp.2\",\n \"description\": \"tnp.7161ac0a-a9cd-4210-9035-910d0c408824:domain-c43\",\n \"path\": \"/infra/host-transport-node-profiles/b065cc94-f2c2-4a21-9fad-9ea86c185eae\",\n \"relative_path\": \"b065cc94-f2c2-4a21-9fad-9ea86c185eae\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"b065cc94-f2c2-4a21-9fad-9ea86c185eae\",\n \"realization_id\": \"b065cc94-f2c2-4a21-9fad-9ea86c185eae\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_time\": 1643135860595,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1643135860595,\n \"_last_modified_user\": \"system\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"host_switch_spec\": {\n \"host_switches\": [\n {\n \"host_switch_name\": \"nsxDefaultHostSwitch\",\n \"host_switch_id\": \"50 34 30 8b c9 77 64 57-1e 89 55 24 bd 32 70 e6\",\n \"host_switch_type\": \"VDS\",\n \"host_switch_mode\": \"STANDARD\",\n \"host_switch_profile_ids\": [\n {\n \"key\": \"UplinkHostSwitchProfile\",\n \"value\": \"/infra/host-switch-profiles/0a26d126-7116-11e5-9d70-feff819cdc9f\"\n }\n ],\n \"uplinks\": [\n {\n \"vds_uplink_name\": \"Uplink 1\",\n \"uplink_name\": \"uplink-1\"\n },\n {\n \"vds_uplink_name\": \"Uplink 2\",\n \"uplink_name\": \"uplink-2\"\n }\n ],\n \"is_migrate_pnics\": false,\n \"ip_assignment_spec\": {\n \"resource_type\": \"AssignedByDhcp\"\n },\n \"cpu_config\": [],\n \"transport_zone_endpoints\": [\n {\n \"transport_zone_id\": \"/infra/sites/default/enforcement-points/default/transport-zones/a95c914d-748d-497c-94ab-10d4647daeba\",\n \"transport_zone_profile_ids\": [\n {\n \"resource_type\": \"BfdHealthMonitoringProfile\",\n \"profile_id\": \"/infra/transport-zone-profiles/52035bb3-ab02-4a08-9884-18631312e50a\"\n }\n ]\n }\n ],\n \"not_ready\": false\n }\n ],\n \"resource_type\": \"StandardHostSwitchSpec\"\n },\n \"ignore_overridden_hosts\": false,\n \"resource_type\": \"PolicyHostTransportNodeProfile\",\n \"id\": \"54b6341e-952a-4253-8b38-66a0e4d5e9b9\",\n \"display_name\": \"transport-node-profile-demo\",\n \"description\": \"description for transport-node-profile-demo\",\n \"tags\": [],\n \"path\": \"/infra/host-transport-node-profiles/54b6341e-952a-4253-8b38-66a0e4d5e9b9\",\n \"relative_path\": \"54b6341e-952a-4253-8b38-66a0e4d5e9b9\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"54b6341e-952a-4253-8b38-66a0e4d5e9b9\",\n \"realization_id\": \"54b6341e-952a-4253-8b38-66a0e4d5e9b9\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_time\": 1643144202008,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1643144202008,\n \"_last_modified_user\": \"admin\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 2,\n \"sort_by\": \"create_time\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/antrea/traceflows/{traceflow-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Read Antrea traceflow config",
"description": "Read Antrea traceflow config with id traceflow-id",
"operationId": "ReadAntreaTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaTraceflowConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/antrea/traceflows/t1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"container_cluster_id\": \"3abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"source_external_id\": \"4abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"destination_external_id\": \"5abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"packet\": {\n \"ipHeader\": {\n \"srcIp\": \"172.16.14.11\",\n \"dstIp\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transportHeader\": {\n \"icmpEchoRequestHeader\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"frameSize\": 255,\n \"resourceType\": \"FIELDS_PACKET_DATA\",\n \"payload\": \"123\",\n \"transportType\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"AntreaTraceflowConfig\",\n \"id\": \"t14\",\n \"display_name\": \"t14\",\n \"path\": \"/infra/antrea/traceflows/t14\",\n \"relative_path\": \"t14\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"d3c59bf3-5de8-4d65-91cc-940458fc8860\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579243672065,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579243672065,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Create an Antrea traceflow config",
"description": "If an Antrea traceflow config with the traceflow-id is not\nalready present, create a new traceflow config.\n",
"operationId": "UpdateAntreaTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaTraceflowConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaTraceflowConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/antrea/traceflows/t14\n{\n \"container_cluster_id\": \"3abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"source_external_id\": \"4abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"destination_external_id\": \"5abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"packet\": {\n \"ipHeader\": {\n \"srcIp\": \"172.16.14.11\",\n \"dstIp\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transportHeader\": {\n \"icmpEchoRequestHeader\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"frameSize\": 255,\n \"resourceType\": \"FIELDS_PACKET_DATA\",\n \"payload\": \"123\",\n \"transportType\": \"UNICAST\"\n },\n \"timeout\": 10\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"container_cluster_id\": \"3abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"source_external_id\": \"4abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"destination_external_id\": \"5abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"packet\": {\n \"ipHeader\": {\n \"srcIp\": \"172.16.14.11\",\n \"dstIp\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transportHeader\": {\n \"icmpEchoRequestHeader\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"frameSize\": 255,\n \"resourceType\": \"FIELDS_PACKET_DATA\",\n \"payload\": \"123\",\n \"transportType\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"AntreaTraceflowConfig\",\n \"id\": \"t14\",\n \"display_name\": \"t14\",\n \"path\": \"/infra/antrea/traceflows/t14\",\n \"relative_path\": \"t14\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"d3c59bf3-5de8-4d65-91cc-940458fc8860\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579243672065,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579243672065,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "AntreaTraceflowConfig"
},
"post": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Restart Antrea traceflow with same set of parameters used during create traceflow",
"description": "This will retrace even if current traceflow has observations. Current\nobservations will be lost. Traceflow configuration will be cleaned up\nby the system after two hours of inactivity.\n",
"operationId": "RestartAntreaTraceflow",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action to be performed",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaTraceflowConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://<policy-mgr>/policy/api/v1/infra/traceflows/t7?action=retrace\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"container_cluster_id\": \"3abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"source_external_id\": \"4abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"destination_external_id\": \"5abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"packet\": {\n \"ipHeader\": {\n \"srcIp\": \"172.16.14.11\",\n \"dstIp\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transportHeader\": {\n \"icmpEchoRequestHeader\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"frameSize\": 255,\n \"resourceType\": \"FIELDS_PACKET_DATA\",\n \"payload\": \"123\",\n \"transportType\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"AntreaTraceflowConfig\",\n \"id\": \"t14\",\n \"display_name\": \"t14\",\n \"path\": \"/infra/antrea/traceflows/t14\",\n \"relative_path\": \"t14\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"d3c59bf3-5de8-4d65-91cc-940458fc8860\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579243672065,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579243672065,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Delete Antrea traceflow config",
"description": "Delete Antrea traceflow config with id traceflow-id",
"operationId": "DeleteAntreaTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/antrea/traceflows/t1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Create an Antrea traceflow config",
"description": "If an Antrea traceflow config with the traceflow-id is not\nalready present, create a new traceflow config.\n",
"operationId": "PatchAntreaTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaTraceflowConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/antrea/traceflows/t12\n{\n \"container_cluster_id\": \"3abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"source_external_id\": \"4abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"destination_external_id\": \"5abe1a62-156c-46be-a70f-ea237344f1c3\",\n \"packet\": {\n \"ipHeader\": {\n \"srcIp\": \"172.16.14.11\",\n \"dstIp\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transportHeader\": {\n \"icmpEchoRequestHeader\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"frameSize\": 255,\n \"resourceType\": \"FIELDS_PACKET_DATA\",\n \"payload\": \"123\",\n \"transportType\": \"UNICAST\"\n },\n \"timeout\": 10\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n",
"x-codegen-request-body-name": "AntreaTraceflowConfig"
}
},
"/infra/settings/firewall/idfw/group-vm-details": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Get all IDFW Group VM details for a given Group",
"description": "Get all Identity Firewall Group VM details for a given Group.\n",
"operationId": "GetGroupVmDetails",
"parameters": [
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "group_path",
"in": "query",
"description": "String Path of the group",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdfwGroupVmDetailListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-ip>/policy/api/v1/infra/settings/firewall/idfw/group-vm-details?group_path=/infra/domains/default/groups/idfw-grp-1\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"group_path\": \"/infra/domains/default/idfw-grp-1\",\n \"results\": [\n {\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"user_sessions\": [\n {\n \"id\": \"9540cd6d-8d46-4c20-b2cc-491efc005865\",\n \"domain_name\": \"IDFW0\",\n \"user_name\": \"administrator\",\n \"user_id\": \"10446e86-99c1-43a7-8345-fda90c56291c\",\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"user_session_id\": 2,\n \"login_time\": 1589165250502,\n \"logout_time\": 0\n }\n ]\n }\n ],\n \"result_count\": 1\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/tep-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"TEP Table"
],
"summary": "Get infra segment TEP table",
"description": "Returns TEP table for a segment\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentTepTable",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTepListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER1_DOWNLINK_SWITCH/tep-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"last_update_timestamp\": 1591745956155,\n \"results\": [\n {\n \"tep_label\": 55298,\n \"tep_ip\": \"100.100.100.3\",\n \"tep_mac_address\": \"00:50:56:6a:af:ce\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Sessions"
],
"summary": "Get L2VPN sessions list result under Tier-0",
"description": "Get paginated list of all L2VPN sessions under Tier-0.\n\n
\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/\nl2vpn-services/<service-id>/sessions instead.\nNote:\n The API will return a new VPN path for \"transport_tunnels\" in the response payload instead of the deprecated API path\n Both paths refer to the same object.\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n",
"operationId": "ListL2VPNSessions",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNSessionListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/locale-services/default/l2vpn-services/default/sessions\n",
"x-vmw-nsx-module": "PolicyLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\": \"L2VPNSession\",\n \"description\": \"Stretched Palo Alto Site\",\n \"display_name\": \"stretched-pa-site\",\n \"enabled\" : true,\n \"transport_tunnels\": [\n \"/infra/tier-0s/ext_net/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 0\n } ]\n}\n"
}
},
"/global-infra/mac-discovery-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "List Mac Discovery Profiles",
"description": "API will list all Mac Discovery Profiles active in current discovery profile id.\n",
"operationId": "GlobalInfraGetMacDiscoveryProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/mac-discovery-profiles\n",
"x-vmw-nsx-module": "PolicyMacDiscovery",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/mac-discovery-profiles/mdp1\",\n \"relative_path\": \"mdp1\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/cluster-control-planes/{cluster-control-plane-id}/heartbeat-config": {
"get": {
"tags": [
"System Administration",
"Monitoring",
"System Health",
"Container",
"Antrea"
],
"summary": "Read Antrea heartbeat configuration",
"description": "Read Antrea heartbeat configuration",
"operationId": "ReadAntreaHeartbeatConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-control-plane-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaHeartbeatConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/heartbeat-config\n",
"x-vmw-nsx-module": "PolicyAntreaMonitoring",
"x-vmw-nsx-example-response": "{\n \"report_interval\": 60,\n \"resource_type\": \"AntreaHeartbeatConfig\",\n \"id\": \"heartbeat-config\",\n \"display_name\": \"heartbeat-config\",\n \"path\": \"/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/heartbeat-config\",\n \"relative_path\": \"heartbeat-config\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01\",\n \"unique_id\": \"3eac8977-1361-4abc-8379-3fae99d36ffd\",\n \"realization_id\": \"3eac8977-1361-4abc-8379-3fae99d36ffd\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1623241055802,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1623399640889,\n \"_revision\": 2\n}\n"
},
"put": {
"tags": [
"System Administration",
"Monitoring",
"System Health",
"Container",
"Antrea"
],
"summary": "Update the Antrea heartbeat configuration",
"description": "Update the Antrea heartbeat configuration",
"operationId": "UpdateAntreaHeartbeatConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-control-plane-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaHeartbeatConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaHeartbeatConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/heartbeat-config\n{\n \"report_interval\": 60,\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyAntreaMonitoring",
"x-vmw-nsx-example-response": "{\n \"report_interval\": 60,\n \"resource_type\": \"AntreaHeartbeatConfig\",\n \"id\": \"heartbeat-config\",\n \"display_name\": \"heartbeat-config\",\n \"path\": \"/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/heartbeat-config\",\n \"relative_path\": \"heartbeat-config\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01\",\n \"unique_id\": \"3eac8977-1361-4abc-8379-3fae99d36ffd\",\n \"realization_id\": \"3eac8977-1361-4abc-8379-3fae99d36ffd\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1623241055802,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1623399640889,\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "AntreaHeartbeatConfig"
},
"patch": {
"tags": [
"System Administration",
"Monitoring",
"System Health",
"Container",
"Antrea"
],
"summary": "Patch the Antrea heartbeat configuration",
"description": "Patch the Antrea heartbeat configuration",
"operationId": "PatchAntreaHeartbeatConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-control-plane-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaHeartbeatConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/heartbeat-config\n{\n \"report_interval\": 60,\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyAntreaMonitoring",
"x-codegen-request-body-name": "AntreaHeartbeatConfig"
}
},
"/infra/segments/{segment-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Read infra segment",
"description": "Read infra segment\nNote:\nExtended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the\n\"l2_extension\" object in the PATCH API payload, the path returned in the GET response payload may include the new path\ninstead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.\nAlso note that l2vpn path included in the error messages returned from validation may include the new VPN path\ninstead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.\n",
"operationId": "ReadInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web-tier\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Segment\",\n \"id\": \"web-tier\",\n \"display_name\": \"web-tier\",\n \"path\": \"/infra/tier-1s/cgw/segments/web-tier\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [\n \"40.1.2.0/24\"\n ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668961954,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668961954,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Create or update a infra segment",
"description": "If segment with the segment-id is not already present, create a new segment.\nIf it already exists, replace the segment with this object.\nNote:\nExtended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the\n\"l2_extension\" object in the PATCH API payload, the path returned in the GET response payload may include the new path\ninstead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.\nAlso note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path\ninstead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.\n",
"operationId": "CreateOrReplaceInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/segments/web-tier\n {\n \"display_name\":\"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [ \"40.1.2.0/24\" ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\",\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Segment\",\n \"id\": \"web-tier\",\n \"display_name\": \"web-tier\",\n \"path\": \"/infra/tier-1s/cgw/segments/web-tier\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [\n \"40.1.2.0/24\"\n ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668961954,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668961954,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "Segment"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Delete infra segment",
"description": "Delete infra segment",
"operationId": "DeleteInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/segments/web-tier\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Create or update a segment",
"description": "If segment with the segment-id is not already present, create a new segment.\nIf it already exists, update the segment with specified attributes.\n",
"operationId": "PatchInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/segments/web-tier\n {\n \"display_name\":\"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [ \"40.1.2.0/24\" ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\"\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "Segment"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "List rules",
"description": "List rules",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListSecurityRules",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}/status": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Tags"
],
"summary": "Get status of tag bulk operation",
"description": "Get status of tag bulk operation with details of tag operation on each virtual machine.\n",
"operationId": "GetVpcTagBulkOperationStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "operation-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagBulkOperationStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/tags/vpc-tag-operations/win-vm-update/status\n",
"x-vmw-nsx-module": "PolicyVpcTag",
"x-vmw-nsx-example-response": "{\n \"tag\": {\n \"scope\": \"os\",\n \"tag\": \"windows\"\n },\n \"status\": \"Error\",\n \"apply_to\": [\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_tag_status\": [\n {\n \"resource_id\": \"e98a906-7b84-42ae-9413-d812cdb64543\",\n \"tag_status\": \"Success\"\n }\n ]\n }\n ],\n \"remove_from\":[\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_tag_status\": [\n {\n \"resource_id\": \"564d8b81-983d-b8ef-686b-161205939c58\",\n \"tag_status\": \"Error\",\n \"details\": \"VM with external id not found\"\n }\n ]\n }\n ],\n}\n"
}
},
"/infra/segment-security-profiles/{segment-security-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profiles"
],
"summary": "GET Segment security profile id",
"description": "API will return details of the segment security profile with given id. If the\nprofile does not exist, it will return 404.\n",
"operationId": "GetSegmentSecurityProfile",
"parameters": [
{
"name": "segment-security-profile-id",
"in": "path",
"description": "Segment security profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segment-security-profiles/my-segment-security-profile-id\n",
"x-vmw-nsx-module": "PolicySegmentSecurity",
"x-vmw-nsx-example-response": "{\n \"bpdu_filter_enable\": true,\n \"bpdu_filter_allow\": [\n \"01:80:c2:00:00:00\",\n \"01:80:c2:00:00:01\"\n ],\n \"dhcp_server_block_enabled\": true,\n \"dhcp_client_block_enabled\": true,\n \"non_ip_traffic_block_enabled\": true,\n \"dhcp_server_block_v6_enabled\": true,\n \"dhcp_client_block_v6_enabled\": true,\n \"ra_guard_enabled\": true,\n \"rate_limits_enabled\": false,\n \"resource_type\": \"SegmentSecurityProfile\",\n \"id\": \"my-segment-security-profile\",\n \"display_name\": \"MySegmentSecurityProfile\",\n \"description\": \"MySegmentSecurityProfile\",\n \"path\": \"/infra/segment-security-profiles/my-segment-security-profile\",\n \"relative_path\": \"my-segment-security-profile\",\n \"parent_path\": \"/infra/segment-security-profiles/my-segment-security-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544566776526,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544566776526,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profiles"
],
"summary": "PUT segment security profile id",
"description": "Create or replace a segment security profile\n",
"operationId": "CreateOrUpdateSegmentSecurityProfile",
"parameters": [
{
"name": "segment-security-profile-id",
"in": "path",
"description": "Segment security profile id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/segment-security-profiles/my-segment-security-profile\n{\n \"resource_type\": \"SegmentSecurityProfile\",\n \"id\": \"MySegmentSecurityProfile\",\n \"display_name\": \"MySegmentSecurityProfile\",\n \"description\": \"MySegmentSecurityProfile\",\n \"bpdu_filter_enable\": true,\n \"bpdu_filter_allow\":[\"01:80:c2:00:00:00\", \"01:80:c2:00:00:01\"],\n \"dhcp_server_block_enabled\": true,\n \"dhcp_client_block_enabled\": true,\n \"non_ip_traffic_block_enabled\": true,\n \"dhcp_server_block_v6_enabled\": true,\n \"dhcp_client_block_v6_enabled\": true,\n \"ra_guard_enabled\": true\n}\n",
"x-vmw-nsx-module": "PolicySegmentSecurity",
"x-vmw-nsx-example-response": "{\n \"resource_type\":\"SegmentSecurityProfile\",\n \"id\":\"MySegmentSecurityProfile\",\n \"display_name\": \"MySegmentSecurityProfile\",\n \"description\": \"MySegmentSecurityProfile\",\n \"path\": \"/infra/segment-security-profiles/my-segment-security-profile-id\",\n \"relative_path\": \"MySegmentSecurityProfile\",\n \"bpdu_filter_enable\": \"true\",\n \"bpdu_filter_allow\":[\"01:80:c2:00:00:00\", \"01:80:c2:00:00:01\"],\n \"dhcp_server_block_enabled\": Boolean,\n \"dhcp_server_block_enabled\": Boolean,\n \"non_ip_traffic_block_enabled\": Boolean,\n \"dhcp_server_block_v6_enabled\": \"true\"\n \"dhcp_server_block_v6_enabled\": \"true\"\n \"ra_guard_enabled\":\"true\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1488995381918,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1488995381918,\n \"_system_owned\": false,\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "SegmentSecurityProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profiles"
],
"summary": "DELETE segment security profile",
"description": "API will delete segment security profile with the given id.\n",
"operationId": "DeleteSegmentSecurityProfile",
"parameters": [
{
"name": "segment-security-profile-id",
"in": "path",
"description": "Segment security profile id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/segment-security-profiles/my-segment-security-profile\n",
"x-vmw-nsx-module": "PolicySegmentSecurity"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profiles"
],
"summary": "PATCH segment security profile id",
"description": "Create a new segment security profile if the segment security profile with given id does not\nexist. Otherwise, PATCH the existing segment security profile\n",
"operationId": "PatchSegmentSecurityProfile",
"parameters": [
{
"name": "segment-security-profile-id",
"in": "path",
"description": "Segment security profile id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/segment-security-profiles/my-segment-security-profile\n{\n \"resource_type\": \"SegmentSecurityProfile\",\n \"id\": \"MySegmentSecurityProfile\",\n \"display_name\": \"MySegmentSecurityProfile\",\n \"description\": \"MySegmentSecurityProfile\",\n \"bpdu_filter_enable\": true,\n \"bpdu_filter_allow\":[\"01:80:c2:00:00:00\", \"01:80:c2:00:00:01\"],\n \"dhcp_server_block_enabled\": true,\n \"dhcp_client_block_enabled\": true,\n \"non_ip_traffic_block_enabled\": true,\n \"dhcp_server_block_v6_enabled\": true,\n \"dhcp_client_block_v6_enabled\": true,\n \"ra_guard_enabled\": true\n}\n",
"x-vmw-nsx-module": "PolicySegmentSecurity",
"x-codegen-request-body-name": "SegmentSecurityProfile"
}
},
"/infra/capacity/threshold": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Capacity Dashboard"
],
"summary": "Returns warning threshold(s) set for NSX Objects.",
"description": "Returns warning threshold(s) set for NSX Objects.",
"operationId": "GetPolicyCapacityThresholds",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapacityThresholdList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/capacity/threshold\n",
"x-vmw-nsx-module": "PolicyCapacityDashboard",
"x-vmw-nsx-example-response": "{\n\"capacity_thresholds\": [\n {\n \"threshold_type\": \"NUMBER_OF_PREPARED_HOSTS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_FIREWALL_RULES\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_ACTIVE_DIRECTORY_DOMAINS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_PROTECTION_ENABLED_VIRTUAL_MACHINES\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"GLOBAL_DEFAULT\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_SEGMENT\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_GROUPS\",\n \"min_threshold_percentage\": 30,\n \"max_threshold_percentage\": 50\n },\n {\n \"threshold_type\": \"NUMBER_OF_SECURITY_POLICY_RULES\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_SECURITY_POLICY\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_SEGMENT_PORT\",\n \"min_threshold_percentage\": 30,\n \"max_threshold_percentage\": 50\n },\n {\n \"threshold_type\": \"NUMBER_OF_EDGE_NODES\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER0_ROUTERS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_FIREWALL_SECTIONS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER1_ROUTERS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_EDGE_CLUSTERS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_NAT_RULES\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_ACTIVE_DIRECTORY_GROUPS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_VSPHERE_CLUSTERS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_PREFIX_LIST\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER1_WITH_NAT_RULE\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_DHCP_IP_POOLS\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_PROTECTION_ENABLED_HOST\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n }\n],\n\"resource_type\": \"CapacityThresholdList\",\n\"id\": \"CapacityThresholdIdentifier\",\n\"display_name\": \"CapacityThresholdIdentifier\",\n\"_create_user\": \"system\",\n\"_create_time\": 1588972275391,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1588972521446,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"Capacity Dashboard"
],
"summary": "Updates the warning threshold(s) for NSX Objects.",
"description": "Updates the warning threshold(s) for NSX Objects specified, and returns\nnew threshold(s). Threshold list in the request must contain value for GLOBAL_DEFAULT\nthreshold_type which represents global thresholds. Threshold type NUMBER_OF_GATEWAY_POLICY is deprecated instead use NUMBER_OF_GATEWAY_FIREWALL_RULES.\n",
"operationId": "UpdatePolicyCapacityThresholds",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapacityThresholdList"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapacityThresholdList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/capacity/threshold\n{\n\"capacity_thresholds\": [\n {\n \"threshold_type\": \"NUMBER_OF_PREPARED_HOSTS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_FIREWALL_RULES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_ACTIVE_DIRECTORY_DOMAINS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_PROTECTION_ENABLED_VIRTUAL_MACHINES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"GLOBAL_DEFAULT\",\n \"min_threshold_percentage\": 60,\n \"max_threshold_percentage\": 70\n },\n {\n \"threshold_type\": \"NUMBER_OF_SEGMENT\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_GROUPS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_SECURITY_POLICY_RULES\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_SECURITY_POLICY\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_SEGMENT_PORT\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_EDGE_NODES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER0_ROUTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_FIREWALL_SECTIONS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER1_ROUTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_EDGE_CLUSTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_NAT_RULES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_ACTIVE_DIRECTORY_GROUPS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_VSPHERE_CLUSTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_PREFIX_LIST\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER1_WITH_NAT_RULE\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_DHCP_IP_POOLS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_PROTECTION_ENABLED_HOST\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n }\n],\n\"resource_type\": \"CapacityThresholdList\",\n\"id\": \"CapacityThresholdIdentifier\",\n\"display_name\": \"CapacityThresholdIdentifier\",\n\"_create_user\": \"system\",\n\"_create_time\": 1588972275391,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1588972521446,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyCapacityDashboard",
"x-vmw-nsx-example-response": "{\n\"capacity_thresholds\": [\n {\n \"threshold_type\": \"NUMBER_OF_PREPARED_HOSTS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_SECURITY_POLICY_RULES\",\n \"min_threshold_percentage\": 70,\n \"max_threshold_percentage\": 100\n },\n {\n \"threshold_type\": \"NUMBER_OF_SEGMENT_PORT\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_ACTIVE_DIRECTORY_GROUPS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_GROUPS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_PREFIX_LIST\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_ACTIVE_DIRECTORY_DOMAINS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER0_ROUTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_EDGE_CLUSTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_VSPHERE_CLUSTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_SEGMENT\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_EDGE_NODES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_NAT_RULES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER1_WITH_NAT_RULE\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_SECURITY_POLICY\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_FIREWALL_SECTIONS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_PROTECTION_ENABLED_HOST\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_DHCP_IP_POOLS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_FIREWALL_RULES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"NUMBER_OF_PROTECTION_ENABLED_VIRTUAL_MACHINES\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n },\n {\n \"threshold_type\": \"GLOBAL_DEFAULT\",\n \"min_threshold_percentage\": 60,\n \"max_threshold_percentage\": 70\n },\n {\n \"threshold_type\": \"NUMBER_OF_TIER1_ROUTERS\",\n \"min_threshold_percentage\": 80,\n \"max_threshold_percentage\": 90\n }\n],\n\"resource_type\": \"CapacityThresholdList\",\n\"id\": \"CapacityThresholdIdentifier\",\n\"display_name\": \"CapacityThresholdIdentifier\",\n\"_create_user\": \"system\",\n\"_create_time\": 1588972275391,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1589228836121,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 2\n}\n",
"x-codegen-request-body-name": "CapacityThresholdList"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"Capacity Dashboard"
],
"summary": "Updates the thresholds for specified NSX Objects.",
"description": "Updates the warning threshold(s) for NSX Objects specified, does not modify\nthresholds for any other objects. Threshold type NUMBER_OF_GATEWAY_POLICY is deprecated instead use NUMBER_OF_GATEWAY_FIREWALL_RULES.\n",
"operationId": "PatchPolicyCapacityThresholds",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CapacityThreshold"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/capacity/threshold\n {\n \"threshold_type\": \"NUMBER_OF_SEGMENT_PORT\",\n \"min_threshold_percentage\": 10,\n \"max_threshold_percentage\": 40\n }\n",
"x-vmw-nsx-module": "PolicyCapacityDashboard",
"x-vmw-nsx-example-response": "",
"x-codegen-request-body-name": "CapacityThreshold"
}
},
"/infra/settings/firewall/security/intrusion-services/global-signatures/{signature-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Get Global IDS signature.",
"description": "Read global intrusion detection signature\n",
"operationId": "GetGlobalIdsSignature",
"parameters": [
{
"name": "signature-id",
"in": "path",
"description": "Signature ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalIdsSignature"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/12345\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n\"signature_id\": \"12345\",\n\"enable\": false,\n\"resource_type\": \"GlobalIdsSignature\",\n\"id\": \"12345\",\n\"display_name\": \"12345\",\n\"path\": \"/infra/settings/firewall/security/intrusion-services/global-signatures/12345\",\n\"relative_path\": \"12345\",\n\"parent_path\": \"/infra\",\n\"unique_id\": \"b4fdaac6-7f1b-48bf-9894-72b97482bb12\",\n\"marked_for_delete\": false,\n\"overridden\": false,\n\"_create_user\": \"admin\",\n\"_create_time\": 1590142586885,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1590142586886,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "create or update Global IDS Signature",
"description": "Update global intrusion detection signature.",
"operationId": "CreateOrUpdateGlobalIdsSignature",
"parameters": [
{
"name": "signature-id",
"in": "path",
"description": "Signature ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalIdsSignature"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalIdsSignature"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/12345\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n\"action\": \"DROP\",\n\"signature_id\": \"12345\",\n\"_revision\": 0\n}\n",
"x-codegen-request-body-name": "GlobalIdsSignature"
},
"delete": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Delete Global IDS signature",
"description": "Delete global intrusion detection signature.\n",
"operationId": "DeleteGlobalIdsSignature",
"parameters": [
{
"name": "signature-id",
"in": "path",
"description": "Signature ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/12345\n",
"x-vmw-nsx-module": "PolicyIDS"
},
"patch": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Patch Global IDS Signature",
"description": "Patch global intrusion detection system signature.",
"operationId": "PatchGlobalIdsSignature",
"parameters": [
{
"name": "signature-id",
"in": "path",
"description": "Signature ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalIdsSignature"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/12345\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n\"action\": \"ALERT\",\n\"signature_id\": \"12345\"\n}\n",
"x-codegen-request-body-name": "GlobalIdsSignature"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "List gateway policies",
"description": "List all gateway policies for specified Domain.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListGatewayPoliciesForDomain",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"default\",\n \"display_name\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"default\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 50000,\n \"category\": \"LocalGatewayRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061800,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 6\n },\n {\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"internal\",\n \"display_name\": \"internal\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/internal\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"internal\",\n \"sequence_number\": 100,\n \"internal_sequence_number\": 20100,\n \"category\": \"SharedPreRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469778,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516295469778,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code": {
"post": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Sessions"
],
"summary": "Create or patch an L2VPN session under Tier-0 from Peer Codes",
"description": "Create or patch an L2VPN session under Tier-0 from Peer Codes.\nIn addition to the L2VPN Session, the IPSec VPN Session, along\nwith the IKE, Tunnel, and DPD Profiles are created and owned by\nthe system. IPSec VPN Service and Local Endpoint are created only\nwhen required, i.e., an IPSec VPN Service does not already exist,\nor an IPSec VPN Local Endpoint with same local address does not\nalready exist.\nUpdating the L2VPN Session can be performed only through this API\nby specifying new peer codes. Use of specific APIs to update the\nL2VPN Session and the different resources associated with it is\nnot allowed, except for IPSec VPN Service and Local Endpoint,\nresources that are not system owned.\nAPI supported only when L2VPN Service is in Client Mode.\n",
"operationId": "CreateOrPatchTier0VpnL2VPNSessionFromPeerCodes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNSessionData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/l2vpn-services/default/sessions/stretched-pa-site?action=create_with_peer_codes\n{\n \"description\": \"Stretched Palo Alto Site\",\n \"display_name\": \"stretched-pa-site\",\n \"transport_tunnels\": [\n {\n \"peer_code\": \"MCw0YTc2YTNlLHsic2l0ZU5hbWUiOiJwb2xpY3ktc2Vzc2lvbi1QUk9WSURFUi5obWl6YS5wYS1wdW5lLXJiLXZwbiIs\n InNyY1RhcElwIjoiMTY5LjI1NC42NC4yIiwiZHN0VGFwSXAiOiIxNjkuMjU0LjY0LjEiLCJpa2VPcHRpb24iOiJpa2V2\n MiIsImVuY2FwUHJvdG8iOiJncmUvaXBzZWMiLCJkaEdyb3VwIjoiZGgxNCIsImVuY3J5cHRBbmREaWdlc3QiOiJhZXMt\n Z2NtL3NoYS0yNTYiLCJwc2siOiJkZWZhdWx0IiwidHVubmVscyI6W3sibG9jYWxJZCI6IjI0LjI0LjI0LjI0IiwicGVl\n cklkIjoiMTEuMTEuMTEuMTEifV19\",\n \"peer_address\": \"10.10.10.10\",\n \"local_address\": \"20.20.20.20\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-codegen-request-body-name": "L2VPNSessionData"
}
},
"/search/dsl": {
"get": {
"tags": [
"Search",
"Search API"
],
"summary": "DSL (Domain Specific Language) search API",
"description": "DSL (Domain Specific Language) search API",
"operationId": "DslSearch",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "query",
"in": "query",
"description": "Search query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/search/dsl?query=group%20where%20tags%20scope%20%3D%20%27prod%27\nGET https://<nsx-mgr>/policy/api/v1/search/dsl?query=group%20where%20tags%20scope%20%3D%20%27prod%27\nGET https://<nsx-mgr>/global-manager/api/v1/search/dsl?query=group%20where%20tags%20scope%20%3D%20%27prod%27\n",
"x-vmw-nsx-module": "Search",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"_last_modified_user\": \"admin\",\n \"_revision\": 4,\n \"_system_owned\": false,\n \"resource_type\": \"Group\",\n \"description\": \"Prod Env Group\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_last_modified_time\": 1561700732921,\n \"display_name\": \"ProdEnvGroup\",\n \"_create_user\": \"admin\",\n \"tags\": [\n {\n \"scope\": \"Prod\",\n \"tag\": \"Group\"\n }\n ],\n \"_create_time\": 1561614698915,\n \"path\": \"/infra/domains/default/groups/4fc8c310-989f-11e9-baf3-930b233a84c6\",\n \"marked_for_delete\": false,\n \"parent_path\": \"/infra/domains/default\",\n \"id\": \"4fc8c310-989f-11e9-baf3-930b233a84c6\",\n \"relative_path\": \"4fc8c310-989f-11e9-baf3-930b233a84c6\",\n \"status\": {\n \"consolidated_status_per_enforcement_point\": [\n {\n \"consolidated_status\": {\n \"consolidated_status\": \"SUCCESS\"\n },\n \"enforcement_point_id\": \"default\"\n }\n ],\n \"consolidated_status\": {\n \"consolidated_status\": \"SUCCESS\"\n },\n \"intent_path\": \"/infra/domains/default/groups/4fc8c310-989f-11e9-baf3-930b233a84c6\"\n }\n }\n ],\n \"result_count\": 1,\n \"cursor\": \"1\"\n}\n"
}
},
"/infra/domains/{domain-id}/forwarding-policies/stats?action=reset": {
"post": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies",
"Rules",
"Statistics"
],
"summary": "Reset Forwarding rule statistics",
"description": "Sets Forwarding Policy rule statistics counter to zero.\n- no enforcement point path specified: Reset of stats will be executed for\n each enforcement point.\n- {enforcement_point_path}: Reset of stats will be executed only for the given\n enforcement point.\n",
"operationId": "ResetForwardingStats",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/stats?action=reset\n",
"x-vmw-nsx-module": "PolicyForwardingStats",
"x-vmw-nsx-example-response": ""
}
},
"/global-infra/firewall-session-timer-profiles/{firewall-session-timer-profile-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profiles"
],
"summary": "Get Firewall Session Timer Profile",
"description": "API will get Firewall Session Timer Profile",
"operationId": "GlobalInfraGetPolicyFirewallSessionTimerProfile",
"parameters": [
{
"name": "firewall-session-timer-profile-id",
"in": "path",
"description": "Firewall Session Timer Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallSessionTimerProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/firewall-session-timer-profiles/profile-1\n",
"x-vmw-nsx-module": "PolicyFirewallSessionTimerProfile",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyFirewallSessionTimerProfile\",\n \"description\": \"\",\n \"name\":\"profile-1\",\n \"id\":\"profile-1\",\n \"display_name\": \"profile-1\",\n \"path\": \"/infra/firewall-session-timer-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"tcp_first_packet\": 120,\n \"tcp_opening\": 30,\n \"tcp_established\": 43200,\n \"tcp_closing\": 900,\n \"tcp_finwait\": 20,\n \"tcp_closed\": 10,\n \"udp_first_packet\": 60,\n \"udp_single\": 30,\n \"udp_multiple\": 60,\n \"icmp_first_packet\": 20,\n \"icmp_error_reply\": 10,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profiles"
],
"summary": "Update Firewall Session Timer Profile",
"description": "API will update Firewall Session Timer Profile",
"operationId": "GlobalInfraUpdatePolicyFirewallSessionTimerProfile",
"parameters": [
{
"name": "firewall-session-timer-profile-id",
"in": "path",
"description": "Firewall Session Timer Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallSessionTimerProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallSessionTimerProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/firewall-session-timer-profiles/profile-1\n{\n \"resource_type\": \"PolicyFirewallSessionTimerProfile\",\n \"description\": \"\",\n \"display_name\": \"profile-1\",\n \"tcp_first_packet\": 120,\n \"tcp_opening\": 30,\n \"tcp_established\": 43200,\n \"tcp_closing\": 900,\n \"tcp_finwait\": 20,\n \"tcp_closed\": 10,\n \"udp_first_packet\": 60,\n \"udp_single\": 30,\n \"udp_multiple\": 60,\n \"icmp_first_packet\": 20,\n \"icmp_error_reply\": 10\n}\n",
"x-vmw-nsx-module": "PolicyFirewallSessionTimerProfile",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyFirewallSessionTimerProfile\",\n \"description\": \"\",\n \"name\":\"profile-1\",\n \"id\":\"profile-1\",\n \"display_name\": \"profile-1\",\n \"path\": \"/infra/firewall-session-timer-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"tcp_first_packet\": 120,\n \"tcp_opening\": 30,\n \"tcp_established\": 43200,\n \"tcp_closing\": 900,\n \"tcp_finwait\": 20,\n \"tcp_closed\": 10,\n \"udp_first_packet\": 60,\n \"udp_single\": 30,\n \"udp_multiple\": 60,\n \"icmp_first_packet\": 20,\n \"icmp_error_reply\": 10,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PolicyFirewallSessionTimerProfile"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profiles"
],
"summary": "Delete Firewall Session Timer Profile",
"description": "API will delete Firewall Session Timer Profile",
"operationId": "GlobalInfraDeletePolicyFirewallSessionTimerProfile",
"parameters": [
{
"name": "firewall-session-timer-profile-id",
"in": "path",
"description": "Firewall Session Timer Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/firewall-session-timer-profiles/firewall-session-timer-profile-id\n",
"x-vmw-nsx-module": "PolicyFirewallSessionTimerProfile"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profiles"
],
"summary": "Create or update Firewall Session Timer Profile",
"description": "API will create/update Firewall Session Timer Profile",
"operationId": "GlobalInfraPatchPolicyFirewallSessionTimerProfile",
"parameters": [
{
"name": "firewall-session-timer-profile-id",
"in": "path",
"description": "Firewall Session Timer Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallSessionTimerProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/firewall-session-timer-profiles/profile-1\n{\n \"resource_type\": \"PolicyFirewallSessionTimerProfile\",\n \"description\": \"\",\n \"display_name\": \"profile-1\",\n \"tcp_first_packet\": 120,\n \"tcp_opening\": 30,\n \"tcp_established\": 43200,\n \"tcp_closing\": 900,\n \"tcp_finwait\": 20,\n \"tcp_closed\": 10,\n \"udp_first_packet\": 60,\n \"udp_single\": 30,\n \"udp_multiple\": 60,\n \"icmp_first_packet\": 20,\n \"icmp_error_reply\": 10\n}\n",
"x-vmw-nsx-module": "PolicyFirewallSessionTimerProfile",
"x-codegen-request-body-name": "PolicyFirewallSessionTimerProfile"
}
},
"/infra/segments/{segment-id}/gateway-interface-arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table for downlink router port on tier-0 router in CSV",
"description": "Get ARP table for downlink router port on tier-0 router in CSV.\n
\nThis API is deprecated because it is duplicate.\nPlease use /infra/segments/<segment-id>/arp-table?format=csv\nSegment ID is the ID of the segment that is connected to the the tier-0\n",
"operationId": "GetDownlinkPortArpTableForInfraSegmentInCsv",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWNLINK_SWITCH/gateway-interface-arp-table?format=csv&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/7f7d37a7-b78e-4378-949d-09190cbfef7d/edge-nodes/a831390e-a7c8-11ea-9102-020063e79023\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,ip\n00:0c:29:ad:24:e4,192.168.100.163\n00:00:00:00:00:00,192.168.100.161\n00:00:00:00:00:00,192.168.100.160\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}/entries": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "List l7 access profile entries",
"description": "API will list all l7 access profiles entries",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListL7AccessEntries",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "l7-access-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessEntryListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/l7-access-profiles/profile-1/entries\n",
"x-vmw-nsx-module": "L7AccessProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry-1\",\n \"display_name\": \"entry-1\",\n \"description\":\"Test Policy L7 Access Profile entry\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry-1\"\n \"relative_path\": \"entry-1\",\n \"marked_for_delete\": false,\"\n \"sequence_number\": 101,\n \"attributes\":[\n {\n \"key\":\"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"CUSTOM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\" : false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n }\n ]\n}\n"
}
},
"/infra/csrs": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"CSR"
],
"summary": "Return All the Generated CSRs",
"description": "Returns information about all of the CSRs that have been created.",
"operationId": "ListTlsCsrs",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCsrListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/csrs\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Csr\",\n \"id\": \"example-csr-id\",\n \"display_name\": \"example-csr-id\",\n \"path\": \"/infra/csrs/example-csr-id\",\n \"parent_path\": \"/infra/csrs/example-csr-id\",\n \"relative_path\": \"example-csr-id\",\n \"pem_encoded\": \"-----BEGIN CERTIFICATE REQUEST----------END CERTIFICATE REQUEST-----\\n\",\n \"key_size\": 2048,\n \"subject\": {\n \"attributes\": [\n {\n \"value\": \"Jane\",\n \"key\": \"CN\"\n },\n {\n \"value\": \"VMware\",\n \"key\": \"O\"\n },\n {\n \"value\": \"NSBU\",\n \"key\": \"OU\"\n },\n {\n \"value\": \"US\",\n \"key\": \"C\"\n },\n {\n \"value\": \"CA\",\n \"key\": \"ST\"\n },\n {\n \"value\": \"PA\",\n \"key\": \"L\"\n }\n ]\n },\n \"algorithm\": \"RSA\",\n \"is_ca\": false,\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516338671237,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516338671237,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segments-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"State"
],
"summary": "Get segment state information",
"description": "Get tier1 segment state information.\n",
"operationId": "GetSegmentState",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentConfigurationState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/it_t1/segments/it-t1-seg/state?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_switch_id\": \"211fe0fb-ae0c-4e16-9560-4b7647adefd8\",\n \"state\": \"success\",\n \"details\": []\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-connection-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Connection Binding Map"
],
"summary": "List SegmentConnectionBindingMap specific Segment",
"description": "List SegmentConnectionBindingMap specific Segment\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListInfraSegmentConnectionBindingMap",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentConnectionBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentConnectionBindingMap\",\n \"display_name\": \"binding-map1\",\n \"path\": \"/infra/tier-1s/tier1/segments/seg1/segment-connection-binding-maps/binding-map1\",\n \"parent_path\": \"/infra/tier-1s/tier1/segments/seg1\",\n \"relative_path\": \"binding-map1\",\n \"vlan_traffic_tag\": \"21\",\n \"segment_path\": \"/infra/segments/seg2\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317362027,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"VPC"
],
"summary": "List of VPC",
"description": "Paginated list of VPC.\n",
"operationId": "ListVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-2/vpcs\n",
"x-vmw-nsx-module": "PolicyVpc",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"service_gateway\": {\n \"disable\": false,\n \"qos_config\": {\n \"ingress_qos_profile_path\": \"/orgs/default/projects/project-1/infra/gateway-qos-profiles/ingress\",\n \"egress_qos_profile_path\": \"/orgs/default/projects/project-1/infra/gateway-qos-profiles/egress\"\n },\n \"auto_snat\": true\n },\n \"default_gateway_path\": \"/infra/tier-0s/pepsi\",\n \"site_infos\": [\n {\n \"edge_cluster_paths\": [\n \"/infra/sites/default/enforcement-points/default/edge-clusters/4a033a2f-d42e-421d-a41b-33333656278a\"\n ],\n \"site_path\": \"/infra/sites/default\"\n }\n ],\n \"external_ipv4_blocks\": [\n \"/infra/ip-blocks/public-1\"\n ],\n \"ipv6_block\": [\n \"/infra/ip-blocks/public-1\"\n ],\n \"private_ipv4_blocks\": [\n \"/orgs/default/projects/project-1/infra/ip-blocks/private\"\n ],\n \"ip_address_type\": \"IPV4\",\n \"ipv6_profile_paths\": [\n \"/infra/ipv6-ndra-profiles/default\",\n \"/infra/ipv6-dad-profiles/default\"\n ],\n \"subnet_profiles\": {},\n \"dhcp_config\": {\n \"enable_dhcp\": true,\n \"dns_client_config\": {\n \"dns_server_ips\": [\n \"value: \\\"192.168.1.25\\\"\\n\"\n ]\n }\n },\n \"short_id\": \"vpc-2\",\n \"resource_type\": \"Vpc\",\n \"id\": \"vpc-2\",\n \"display_name\": \"vpc-2\",\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-2\",\n \"relative_path\": \"vpc-2\",\n \"parent_path\": \"/orgs/default/projects/project-1\",\n \"unique_id\": \"21064fec-0850-4468-8b30-1c761a52c465\",\n \"realization_id\": \"21064fec-0850-4468-8b30-1c761a52c465\",\n \"owner_id\": \"14565b02-e277-4ac8-a6b8-2d25e5aab9c7\",\n \"origin_site_id\": \"14565b02-e277-4ac8-a6b8-2d25e5aab9c7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_time\": 1661225865141,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1661225865141,\n \"_last_modified_user\": \"admin\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/ipfix-dfw-profiles/{ipfix-dfw-profile-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"IPFIX",
"Firewall IPFIX Profiles"
],
"summary": "Get IPFIX DFW Profile",
"description": "API will return details of IPFIX DFW profile.\n",
"operationId": "ReadIPFIXDFWProfile",
"parameters": [
{
"name": "ipfix-dfw-profile-id",
"in": "path",
"description": "IPFIX DFW collection id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPFIXDFWProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipfix-dfw-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyIPFIXDFW",
"x-vmw-nsx-example-response": "{\n \"ipfix_dfw_collector_profile_path\": \"/infra/ipfix-dfw-collector-profiles/profile1\",\n \"active_flow_export_timeout\": 40,\n \"observation_domain_id\": 344,\n \"priority\": 770,\n \"resource_type\": \"IPFIXDFWProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"profile1\",\n \"path\": \"/infra/ipfix-dfw-profiles/profile1\",\n \"relative_path\": \"profile1\",\n \"parent_path\": \"/infra/ipfix-dfw-profiles/profile1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1545257663086,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1545257663086,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"IPFIX",
"Firewall IPFIX Profiles"
],
"summary": "Create or Replace IPFIX DFW collection Config.",
"description": "Create or replace IPFIX DFW profile. Config will start\nforwarding data to provided IPFIX DFW collector.\n",
"operationId": "CreateOrReplaceIPFIXDFWProfile",
"parameters": [
{
"name": "ipfix-dfw-profile-id",
"in": "path",
"description": "IPFIX DFW Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPFIXDFWProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPFIXDFWProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ipfix-dfw-profiles/profile1\n {\n \"ipfix_dfw_collector_profile_path\": \"/infra/ipfix-dfw-collector-profiles/profile1\",\n \"observation_domain_id\": 344,\n \"active_flow_export_timeout\":40,\n \"priority\":771,\n \"_revision\" : 0\n }\n",
"x-vmw-nsx-module": "PolicyIPFIXDFW",
"x-vmw-nsx-example-response": "{\n \"ipfix_dfw_collector_profile_path\": \"/infra/ipfix-dfw-collector-profiles/profile1\",\n \"active_flow_export_timeout\": 40,\n \"observation_domain_id\": 344,\n \"priority\": 771,\n \"resource_type\": \"IPFIXDFWProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"profile1\",\n \"path\": \"/infra/ipfix-dfw-profiles/profile1\",\n \"relative_path\": \"profile1\",\n \"parent_path\": \"/infra/ipfix-dfw-profiles/profile1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1545257663086,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1545259987846,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "IPFIXDFWProfile"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"IPFIX",
"Firewall IPFIX Profiles"
],
"summary": "Delete IPFIX DFW Profile",
"description": "API deletes IPFIX DFW Profile. Selected IPFIX Collectors will stop\nreceiving flows.\n",
"operationId": "DeleteIPFIXDFWProfile",
"parameters": [
{
"name": "ipfix-dfw-profile-id",
"in": "path",
"description": "IPFIX DFW Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/ipfix-dfw-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyIPFIXDFW"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"IPFIX",
"Firewall IPFIX Profiles"
],
"summary": "Patch IPFIX DFW profile",
"description": "Create a new IPFIX DFW profile if the IPFIX DFW profile\nwith given id does not already exist. If the IPFIX DFW\nprofile with the given id already exists, patch with\nthe existing IPFIX DFW profile.\n",
"operationId": "PatchIPFIXDFWProfile",
"parameters": [
{
"name": "ipfix-dfw-profile-id",
"in": "path",
"description": "IPFIX DFW Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPFIXDFWProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ipfix-dfw-profiles/profile1\n{\n \"ipfix_dfw_collector_profile_path\": \"/infra/ipfix-dfw-collector-profiles/profile1\",\n \"observation_domain_id\": 344,\n \"active_flow_export_timeout\":40,\n \"priority\":770,\n \"_create_user\": \"admin\",\n \"_create_time\": 1545257663086,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1545259987846,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyIPFIXDFW",
"x-codegen-request-body-name": "IPFIXDFWProfile"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/firewall-flood-protection-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "List Firewall Flood Protection Profile Binding Maps for all domains",
"description": "API will list all Firewall Flood Protection Profile Binding Maps across all domains.\nThis API returns the binding maps order by the sequence number.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListFirewallFloodProtectionBindingsAcrossDomains",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/firewall-flood-protection-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"binding-map-1\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallFloodProtectionProfileBindingMaps\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/drafts/{draft-id}/aggregated_with_pagination": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Get paginated aggregated configuration for the draft",
"description": "Get a paginated aggregated configuration of a given draft. This aggregated\nconfiguration is the differnece between the current published firewall\nconfiguration and a firewall configuration stored in a given draft.\nFor an initial API call, if request_id is present in a response, then this is\na paginated aggregated configuration of a given draft, containing all the\nsecurity policies from the aggregated configuration.\nUsing this request_id, more granular aggregated configuration, at security\npolicy level, can be fetched from subsequent API calls.\nAbsence of request_id suggests that whole aggregated configuration has been\nreturned as a response to initial API call, as the size of aggregated\nconfiguration is not big enough to need pagination.\n",
"operationId": "GetPolicyDraftPaginatedAggregatedConfigurationResult",
"parameters": [
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "request_id",
"in": "query",
"description": "Request identifier to track subsequent API calls",
"schema": {
"type": "string"
}
},
{
"name": "root_path",
"in": "query",
"description": "Path of the root object of subtree",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDraftPaginatedAggregatedConfigurationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "1.Initial call to get paginated aggregated configuration.\n GET https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft/aggregated_with_pagination\n\n2.Call to get the detailed aggregated configuration for a security policy\n GET https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft/aggregated_with_pagination?request_id=3cd6bdc3-3f9c-4521-888d-4b23c3200206&root_path=/infra/domains/default/security-policies/app-section-1\n",
"x-vmw-nsx-module": "PolicyDraft",
"x-vmw-nsx-example-response": "1. Response to initial call to get paginated aggregated configuration.\n{\n \"request_id\": \"3cd6bdc3-3f9c-4521-888d-4b23c3200206\",\n \"result\": {\n \"resource_type\": \"Infra\",\n \"id\": \"infra\",\n \"display_name\": \"infra\",\n \"path\": \"/infra\",\n \"children\": [\n {\n \"children\": [\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-1\",\n \"display_name\": \"app-section-1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 0,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"rule_count\": 200,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n },\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-2\",\n \"display_name\": \"app-section-2\",\n \"path\": \"/infra/domains/default/security-policies/app-section-2\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 0,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"rule_count\": 200,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"target_type\": \"Domain\",\n \"resource_type\": \"ChildResourceReference\",\n \"id\": \"default\",\n \"marked_for_delete\": false,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n}\n\n2. Response to a call to get the detailed aggregated configuration for a security policy\n{\n \"request_id\": \"3cd6bdc3-3f9c-4521-888d-4b23c3200206\",\n \"result\": {\n \"resource_type\": \"Infra\",\n \"id\": \"infra\",\n \"display_name\": \"infra\",\n \"path\": \"/infra\",\n \"children\": [\n {\n \"children\": [\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-1\",\n \"display_name\": \"app-section-1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1\",\n \"children\": [\n {\n \"Rule\": {\n \"action\": \"ALLOW\",\n \"resource_type\": \"Rule\",\n \"id\": \"rule_1\",\n \"display_name\": \"rule_1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1/rules/rule_1\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 1,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"/infra/domains/default/groups/d1\"\n ],\n \"destination_groups\": [\n \"/infra/domains/default/groups/d2\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"profiles\": [\n \"ANY\"\n ],\n \"logged\": true,\n \"scope\": [\n \"ANY\"\n ],\n \"disabled\": false,\n \"notes\": \"\",\n \"direction\": \"IN_OUT\",\n \"ip_protocol\": \"IPV4_IPV6\",\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildRule\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 0,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"rule_count\": 200,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"target_type\": \"Domain\",\n \"resource_type\": \"ChildResourceReference\",\n \"id\": \"default\",\n \"marked_for_delete\": false,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n}\n"
}
},
"/infra/ip-address-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given IP address is a member",
"description": "Get policy groups for which the given IP address is a member.\n",
"operationId": "GetGroupsForIPAddress",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "ip_address",
"in": "query",
"description": "IPAddress",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-address-group-associations?ip_address=10.1.19.10&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/troubleshoot": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes Troubleshoot Properties"
],
"summary": "Read a StaticRouteBfdTroubleshootConfig",
"description": "Read a StaticRouteBfdTroubleshootConfig\n",
"operationId": "ReadStaticRouteBfdTroubleshootConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRouteBfdTroubleshootConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/t0/static-routes/bfd-peers/troubleshoot\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"bfd_control_pkt_diagnostics\": \"true\",\n \"system_diagnostics\": \"true\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes Troubleshoot Properties"
],
"summary": "Create or update a StaticRouteBfdTroubleshootConfig",
"description": "If a StaticRouteBfdTroubleshootConfig is not already present,\ncreate a new StaticRouteBfdTroubleshootConfig. If it already exists, update the\nStaticRouteBfdTroubleshootConfig. This operation will fully replace the object.\n",
"operationId": "CreateOrReplaceStaticRouteBfdTroubleshootConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRouteBfdTroubleshootConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRouteBfdTroubleshootConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/t0/static-routes/bfd-peers/troubleshoot\n{\n \"bfd_control_pkt_diagnostics\": \"true\",\n \"system_diagnostics\": \"true\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"bfd_control_pkt_diagnostics\": \"true\",\n \"system_diagnostics\": \"true\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "StaticRouteBfdTroubleshootConfig"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes Troubleshoot Properties"
],
"summary": "Create or update a StaticRouteBfdTroubleshootConfig",
"description": "If a StaticRouteBfdTroubleshootConfig is not already present,\ncreate a new StaticRouteBfdTroubleshootConfig. If it already exists, update the\nStaticRouteBfdTroubleshootConfig. This is a full replace.\n",
"operationId": "PatchStaticRouteBfdTroubleshootConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRouteBfdTroubleshootConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/t0/static-routes/bfd-peers/troubleshoot\n {\n \"bfd_control_pkt_diagnostics\": \"true\",\n \"system_diagnostics\": \"true\"\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n",
"x-codegen-request-body-name": "StaticRouteBfdTroubleshootConfig"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Get segment security profile binding map",
"description": "API will return details of the segment security profile binding map. If the\nbinding map does not exist, it will return 404.\n",
"operationId": "GetSegmentSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-security-profile-binding-map-id",
"in": "path",
"description": "segment security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentSecurityProfileBindingMap\",\n \"id\": \"segment_security_binding_map_1\",\n \"display_name\": \"segment_security_binding_map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1\",\n \"relative_path\": \"segment_security_binding_map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539129320511,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129320511,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Create or replace segment security profile binding map",
"description": "API will create or replace segment security profile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "CreateOrUpdateSegmentSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-security-profile-binding-map-id",
"in": "path",
"description": "segment security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\n {\n \"resource_type\": \"SegmentSecurityProfileBindingMap\",\n \"id\": \"segment_security_binding_map_1\",\n \"display_name\": \"segment_security_binding_map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1\",\n \"relative_path\": \"segment_security_binding_map_1\",\n \"marked_for_delete\": false,\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segment_security_2\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539129320511,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129320511,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentSecurityProfileBindingMap\",\n \"id\": \"segment_security_binding_map_1\",\n \"display_name\": \"segment_security_binding_map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1\",\n \"relative_path\": \"segment_security_binding_map_1\",\n \"marked_for_delete\": false,\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segment_security_2\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539129320511,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129593401,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SegmentSecurityProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Delete segment security profile binding map",
"description": "API will delete segment security profile binding map.\n",
"operationId": "DeleteSegmentSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-security-profile-binding-map-id",
"in": "path",
"description": "segment security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Security Profile Binding"
],
"summary": "Patch segment security profile binding map",
"description": "Create a new segment security profile binding map if the given security\nprofile binding map does not exist. Otherwise, patch the existing segment\nsecurity profile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "PatchSegmentSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-security-profile-binding-map-id",
"in": "path",
"description": "segment security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\n {\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\"\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-codegen-request-body-name": "SegmentSecurityProfileBindingMap"
}
},
"/global-infra/tier-0s/{tier0-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Get Flood Protection Profile Binding Map for Tier-0 Logical Router",
"description": "API will get Flood Protection Profile Binding Map for Tier-0 Logical Router.\n",
"operationId": "GlobalInfraGetTier0FloodProtectionProfileBinding",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "flood-protection-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
}
},
"/infra/settings/firewall/security/exclude-list?action=filter": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Exclusion List"
],
"summary": "Filter the firewall exclude list",
"description": "Filter the firewall exclude list by the given object, to check whether\nthe object is a member of this exclude list.\n",
"operationId": "FilterFirewallExcludeList",
"parameters": [
{
"name": "deep_check",
"in": "query",
"description": "Check all parents",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "intent_path",
"in": "query",
"description": "Path of the intent object to be searched in the exclude list",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReference"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/exclude-list?action=filter&intent_path=/infra/domains/default/groups/app-group\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"target_display_name\": \"app-group\",\n \"is_valid\": true,\n \"target_type\": \"Group\",\n \"target_id\": \"app-group\",\n \"path\": \"/infra/domains/default/groups/app-group\"\n}\n"
}
},
"/infra/tls-inspection-policies/{policy-id}/rules": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Tls Inspection",
"Tls Rules"
],
"summary": "List TLS rules",
"description": "List TLS rules",
"operationId": "ListTlsRules",
"parameters": [
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsRuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tls-inspection-policies/default/rules\n",
"x-vmw-nsx-module": "PolicyTlsPolicy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"TlsRule\",\n \"description\": \"rule1\",\n \"id\": \"rule1\",\n \"display_name\": \"rule1\",\n \"path\": \"/infra/tls-inspection-policies/default/rules/rule1\",\n \"parent_path\": \"/infra/tls-inspection-policies/default\",\n \"relative_path\": \"rule1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/domains/default/groups/source1\",\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/default/groups/destination1\",\n ],\n \"scope\": [\n \"/infra/tier-0s/coke\"\n ],\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"context_profiles\": [\n \"/infra/context-profiles/HTTP\",\n \"/infra/context-profiles/HTTP2\"\n ],\n \"tls_profile\": \"/infra/tls-inspection-action-profiles/external-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/redirection-policies/{redirection-policy-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Redirection Policies"
],
"summary": "Read redirection policy",
"description": "Read redirection policy.\n",
"operationId": "ReadRedirectionPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirection-policy-id",
"in": "path",
"description": "Redirection map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedirectionPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/redirection-policies/RedirectionPolicy_12\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"rules\": [\n {\n \"action\": \"REDIRECT\",\n \"resource_type\": \"RedirectionRule\",\n \"id\": \"Rule-1\",\n \"display_name\": \"Rule-1\",\n \"description\": \"Rule 1 - ANY to Web\",\n \"path\": \"/infra/domains/default/redirection-policies/RedirectionPolicy_12/rules/Rule-1\",\n \"relative_path\": \"Rule-1\",\n \"parent_path\": \"/infra/domains/default/redirection-policies/RedirectionPolicy_12\",\n \"marked_for_delete\": false,\n \"rule_id\": 56842019,\n \"sequence_number\": 1,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"/infra/domains/default/groups/web\"\n ],\n \"services\": [\n \"/infra/services/ORACLE-FORM-SERVICES\"\n ],\n \"profiles\": [\n \"ANY\"\n ],\n \"logged\": false,\n \"scope\": [\n \"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1383/interfaces/1-policyconnectivity-658\"\n ],\n \"disabled\": true,\n \"direction\": \"IN_OUT\",\n \"ip_protocol\": \"IPV4_IPV6\",\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1566307301463,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1566307301463,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"redirect_to\": [\n \"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1383/service-instances/PAN-1\"\n ],\n # Flag to denote N-S direction is set.\n \"north_south\": true,\n \"resource_type\": \"RedirectionPolicy\",\n \"id\": \"RedirectionPolicy_12\",\n \"display_name\": \"RedirectionPolicy_12\",\n \"description\": \"Test Redirection Policy\",\n \"path\": \"/infra/domains/default/redirection-policies/RedirectionPolicy_12\",\n \"relative_path\": \"RedirectionPolicy_12\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"4d0a51a6-a6f8-4bca-83d8-b58ee831ce00\",\n \"marked_for_delete\": false,\n \"sequence_number\": 0,\n \"internal_sequence_number\": 13000000,\n \"category\": \"Application\",\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n # Scope set to any as none was passed in the request.\n \"scope\": [\n \"ANY\"\n ],\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1566307301455,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1566307301455,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Redirection Policies"
],
"summary": "Create or update redirection policy",
"description": "Create or update the redirection policy.\nPerformance Note: If you want to edit several rules in a redirection policy\nuse this API. It will perform better than several individual rule APIs.\nJust pass all the rules which you wish to edit as embedded rules to it.\n",
"operationId": "CreateOrUpdateRedirectionPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirection-policy-id",
"in": "path",
"description": "Redirection map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedirectionPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedirectionPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/default/redirection-policies/RedirectionPolicy_12\n{\n \"rules\": [\n {\n \"action\": \"REDIRECT\",\n \"resource_type\": \"RedirectionRule\",\n \"id\": \"Rule-1\",\n \"display_name\": \"Rule-1\",\n \"description\": \"Rule 1 - ANY to Web\",\n \"sequence_number\": 1,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"/infra/domains/default/groups/web\"\n ],\n \"services\": [\n \"/infra/services/ORACLE-FORM-SERVICES\"\n ],\n \"profiles\": [\n \"ANY\"\n ],\n \"logged\": false,\n \"scope\": [\n \"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1383/interfaces/1-policyconnectivity-658\"\n ],\n \"disabled\": true,\n \"direction\": \"IN_OUT\",\n \"ip_protocol\": \"IPV4_IPV6\"\n }\n ],\n \"redirect_to\": [\n \"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1383/service-instances/PSI-1\"\n ],\n \"resource_type\": \"RedirectionPolicy\",\n \"display_name\": \"RedirectionPolicy_12\",\n \"description\": \"Test Redirection Policy\",\n \"parent_path\": \"/infra/domains/default\",\n \"marked_for_delete\": false,\n \"sequence_number\": 0,\n \"category\": \"Application\",\n \"stateful\": true,\n \"locked\": false\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"rules\": [\n {\n \"action\": \"REDIRECT\",\n \"resource_type\": \"RedirectionRule\",\n \"id\": \"Rule-1\",\n \"display_name\": \"Rule-1\",\n \"description\": \"Rule 1 - ANY to Web\",\n \"path\": \"/infra/domains/default/redirection-policies/RedirectionPolicy_12/rules/Rule-1\",\n \"relative_path\": \"Rule-1\",\n \"parent_path\": \"/infra/domains/default/redirection-policies/RedirectionPolicy_12\",\n \"marked_for_delete\": false,\n \"rule_id\": 56842019,\n \"sequence_number\": 1,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"/infra/domains/default/groups/web\"\n ],\n \"services\": [\n \"/infra/services/ORACLE-FORM-SERVICES\"\n ],\n \"profiles\": [\n \"ANY\"\n ],\n \"logged\": false,\n \"scope\": [\n \"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1383/interfaces/1-policyconnectivity-658\"\n ],\n \"disabled\": true,\n \"direction\": \"IN_OUT\",\n \"ip_protocol\": \"IPV4_IPV6\",\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1566307301463,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1566307301463,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"redirect_to\": [\n \"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1383/service-instances/PAN-1\"\n ],\n # Flag to denote N-S direction is set.\n \"north_south\": true,\n \"resource_type\": \"RedirectionPolicy\",\n \"id\": \"RedirectionPolicy_12\",\n \"display_name\": \"RedirectionPolicy_12\",\n \"description\": \"Test Redirection Policy\",\n \"path\": \"/infra/domains/default/redirection-policies/RedirectionPolicy_12\",\n \"relative_path\": \"RedirectionPolicy_12\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"4d0a51a6-a6f8-4bca-83d8-b58ee831ce00\",\n \"marked_for_delete\": false,\n \"sequence_number\": 0,\n \"internal_sequence_number\": 13000000,\n \"category\": \"Application\",\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n # Scope set to any as none was passed in the request.\n \"scope\": [\n \"ANY\"\n ],\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1566307301455,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1566307301455,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "RedirectionPolicy"
},
"delete": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Redirection Policies"
],
"summary": "Delete redirection policy",
"description": "Delete redirection policy.",
"operationId": "DeleteRedirectionPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirection-policy-id",
"in": "path",
"description": "Redirection map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/domain-id/redirection-policies/redirection-policy-id\n",
"x-vmw-nsx-module": "PolicyServiceInsertion"
},
"patch": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Redirection Policies"
],
"summary": "Create or update redirection policy",
"description": "Create or update the redirection policy.\nPerformance Note: If you want to edit several rules in a redirection policy\nuse this API. It will perform better than several individual rule APIs.\nJust pass all the rules which you wish to edit as embedded rules to it.\n",
"operationId": "PatchRedirectionPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "redirection-policy-id",
"in": "path",
"description": "Redirection map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedirectionPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/default/redirection-policies/RedirectionPolicy_1\n{\n \"resource_type\": \"RedirectionPolicy\",\n \"description\": \"RedirectionPolicy_1\",\n \"display_name\": \"RedirectionPolicy_1\",\n \"rules\": [{\n \"resource_type\": \"RedirectionRule\",\n \"description\": \"Rule 1 - ANY to Web\",\n \"id\": \"Rule-1\",\n \"display_name\": \"Rule-1\",\n \"action\": \"REDIRECT\",\n \"disabled\": true,\n \"sequence_number\": 1,\n \"source_groups\": [\n \"ANY\"\n ],\n # Scope for redirection rule\n \"scope\": [\"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1303/interfaces/1-policyconnectivity-1310\"],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/default/groups/web\"\n ],\n \"services\": [\n \"/infra/services/ORACLE-FORM-SERVICES\"\n ]\n }\n ],\n \"redirect_to\": [\"/infra/tier-0s/tier0/locale-services/1-policyconnectivity-1303/service-instances/PSI-1\"]\n # Scope not provided for policy. It will be internally decided based on redirect to path. Here, it will be tier0.\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-codegen-request-body-name": "RedirectionPolicy"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions",
"Summary"
],
"summary": "Get IPSec VPN Session Summary",
"description": "Summarized view of all tier-0 IPSec VPN sessions for a specified service.\n\n
\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/summary\ninstead.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier0IpsecVpnSessionSummary",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIpsecVpnIkeServiceSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-0s/TLR0_LR/locale-services/TIER0_LOCAL_SERVICE/ipsec-vpn-services/test-ipsec-svc/summary\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": "{\n \"ipsec_vpn_service_path\": \"/infra/tier-0s/TLR0_LR/locale-services/TIER0_LOCAL_SERVICE/ipsec-vpn-services/test-ipsec-svc\",\n \"display_name\": \"test-ipsec-svc\",\n \"session_summary\": {\n \"established_sessions\": 0,\n \"failed_sessions\": 1,\n \"degraded_sessions\": 0,\n \"total_sessions\": 1\n },\n \"aggregate_traffic_counters\": {\n \"packets_in\": 0,\n \"packets_out\": 0,\n \"bytes_in\": 0,\n \"bytes_out\": 0,\n \"dropped_packets_in\": 0,\n \"dropped_packets_out\": 0\n },\n \"traffic_summary_per_session\": [\n {\n \"traffic_counters\": {\n \"packets_in\": 0,\n \"packets_out\": 0,\n \"bytes_in\": 0,\n \"bytes_out\": 0,\n \"dropped_packets_in\": 0,\n \"dropped_packets_out\": 0\n },\n \"ipsec_vpn_session\": {\n \"target_id\": \"/infra/tier-1s/TLR0_LR/locale-services/TIER0_LOCAL_SERVICE/ipsec-vpn-services/test-ipsec-svc/sessions/2a30271f-a856-4168-9097-b5955f40d446\",\n \"target_type\": \"IPSecVPNSession\",\n \"is_valid\": true\n }\n }\n ]\n}\n"
}
},
"/infra/ipsec-vpn-ike-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IKE Profiles"
],
"summary": "List IKE profiles",
"description": "Get paginated list of all IKE Profiles.",
"operationId": "ListIPSecVpnIkeProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnIkeProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-ike-profiles",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n \"resource_type\" : \"IPSecVpnIkeProfile\",\n \"path\": \"/infra/ipsec-vpn-ike-profiles/aws-ike-profile\",\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"ike_version\" : \"IKE_V1\",\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 86400,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/gateway-firewall": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Tier-1 Gateways"
],
"summary": "Get list of gateway policies with rules that belong\nto the specific Tier-1 LocalServices.\n",
"description": "Get filtered view of Gateway Firewall rules associated\nwith the Tier-1 Locale Services. The gateway policies are\nreturned in the order of category and sequence number.\n",
"operationId": "GlobalInfraViewTier1LocaleServicesGatewayFirewall",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/locale-services/locale-1/gateway-firewall\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"default\",\n \"display_name\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"default\",\n \"sequence_number\": 10,\n \"internal_sequence_number\": 20010,\n \"category\": \"POST_RULES\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-1s/t1/locale-services/locale-1\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061800,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 6\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/security-policies/{security-policy-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Read security policy",
"description": "Read security policy for a domain.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadSecurityPolicyForDomain",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SecurityPolicy\",\n \"description\": \"comm map\",\n \"id\": \"application-section-1\",\n \"display_name\": \"application-section-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"application-section-1\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ],\n \"category\": \"Application\",\n \"precedence\": 0,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317362027,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Create or Update security policy",
"description": "Create or Update the security policy for a domain. This is a full replace.\nAll the rules are replaced.\nPerformance Note: If you want to edit several rules in a security policy,\nuse this API. It will perform better than several individual rule APIs.\nJust pass all the rules which you wish to edit as embedded rules to it.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateSecurityPolicyForDomain",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1\n{\n \"description\": \"comm map\",\n \"display_name\": \"application-section-1\",\n \"category\": \"Application\",\n \"rules\": [\n {\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"action\": \"ALLOW\"\n }\n\n ]\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SecurityPolicy\",\n \"description\": \"comm map\",\n \"id\": \"application-section-1\",\n \"display_name\": \"application-section-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"application-section-1\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ],\n \"category\": \"Application\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 13000000,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317362027,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "SecurityPolicy"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Deletes a security policy from this domain",
"description": "Deletes the security policy along with all the rules\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteSecurityPolicyForDomain",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Patch security policy",
"description": "Patch the security policy for a domain. If a security policy for the given\nsecurity-policy-id is not present, the object will get created and if it is\npresent it will be updated. This is a full replace.\nPerformance Note: If you want to edit several rules in a security policy\nuse this API. It will perform better than several individual rule APIs.\nJust pass all the rules which you wish to edit as embedded rules to it.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchSecurityPolicyForDomain",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1\n{\n \"description\": \"comm map patched\",\n \"display_name\": \"application-section-1\",\n \"category\": \"Application\",\n \"rules\": [\n {\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"action\": \"ALLOW\"\n }\n\n ]\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-codegen-request-body-name": "SecurityPolicy"
}
},
"/infra/latency-profiles/{profile-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Latency"
],
"summary": "Read latency profile",
"description": "Read latency profile.\n",
"operationId": "ReadPolicyLatencyStatProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"description": "Latency profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLatencyStatProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/latency-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyLatency",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyLatencyStatProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"/infra/latency-profiles/profile1\",\n \"path\": \"/infra/latency-profiles/profile1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile1\",\n \"sampling_rate\" : 120,\n \"sampling_interval\": 10,\n \"pnic_latency_enabled\" : false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"Latency"
],
"summary": "Create or Replace latency profile",
"description": "Create or Replace latency profile.\n",
"operationId": "CreateOrReplacePolicyLatencyStatProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"description": "Latency profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLatencyStatProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLatencyStatProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/latency-profiles/profile1\n{\n \"sampling_rate\": 100,\n \"sampling_interval\": 10,\n \"pnic_latency_enabled\": false,\n}\n",
"x-vmw-nsx-module": "PolicyLatency",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyLatencyStatProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"/infra/latency-profiles/profile1\",\n \"path\": \"/infra/latency-profiles/profile1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile1\",\n \"sampling_rate\" : 100,\n \"sampling_interval\": 10,\n \"pnic_latency_enabled\" : false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyLatencyStatProfile"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"Latency"
],
"summary": "Delete latency profile",
"description": "Delete an existing latency profile",
"operationId": "DeletePolicyLatencyStatProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"description": "Latency profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/latency-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyLatency"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"Latency"
],
"summary": "Patch latency profile",
"description": "Patch latency profile.\n",
"operationId": "PatchPolicyLatencyStatProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"description": "Latency profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLatencyStatProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLatencyStatProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/latency-profiles/profile1\n{\n \"sampling_rate\": 120\n}\n",
"x-vmw-nsx-module": "PolicyLatency",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyLatencyStatProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"/infra/latency-profiles/profile1\",\n \"path\": \"/infra/latency-profiles/profile1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile1\",\n \"sampling_rate\" : 120,\n \"sampling_interval\": 10,\n \"pnic_latency_enabled\" : false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PolicyLatencyStatProfile"
}
},
"/orgs": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"Org"
],
"summary": "List of Org",
"description": "Paginated list of Org.\n",
"operationId": "ListOrg",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrgListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs\n",
"x-vmw-nsx-module": "PolicyOrg",
"x-vmw-nsx-example-response": "{\n \"result_count\": 1,\n \"results\": [{\n resource_type\": \"Org\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/orgs/default\",\n \"relative_path\": \"default\",\n \"parent_path\": \"/orgs/default\",\n \"unique_id\": \"7e6bf1bf-354b-423d-a1d3-7fdacf826154\",\n \"realization_id\": \"7e6bf1bf-354b-423d-a1d3-7fdacf826154\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_time\": 1662610383514,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1662610383514,\n \"_last_modified_user\": \"system\",\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }]\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/ip-groups": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Effective IPGroups that belong to this group.",
"description": "Returns effective IPGroups that belong to this group.\nThis API is applicable only for Groups containing IPSet member type.\nFor Groups containing other member types,it returns an empty list.\n",
"operationId": "GetGroupIPAddressGroupMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/ip-groups?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"cursor\": \"00361f148bdc-fe7c-4320-8ef3-594e28d57c87Iws-2\",\n \"sort_ascending\": true,\n \"result_count\": 2,\n \"results\": [\n {\n \"target_id\" : \"fcb51d1d-b141-4f5b-a0b9-1063a1470a63\",\n \"target_display_name\" : \"IPSet1\",\n \"target_type\" : \"IPSet\",\n },\n {\n \"id\" : \"3eecac54-15e7-4a0d-b418-001052fcfdcd\",\n \"display_name\" : \"IPSet2\",\n \"target_type\" : \"IPSet\"\n }\n ]\n }\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}?action=reprocess": {
"post": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Gateways"
],
"summary": "Reprocess Tier1 gateway configuration and publish updates to NSX controller",
"description": "Reprocess Tier1 gateway configuration and configuration of related entities like Tier1 interfaces\nand static routes, etc. Any missing Updates are published to NSX controller.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraTier1GatewayReprocess",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1_1?action=reprocess\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
}
},
"/global-infra/gateway-qos-profiles/{qos-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Read gateway QoS profile",
"description": "Read gateway QoS profile",
"operationId": "GlobalInfraReadGatewayQosProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"committed_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\",\n \"resource_type\": \"GatewayQosProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"profile1\",\n \"path\": \"/infra/gateway-qos-profiles/profile1\",\n \"relative_path\": \"profile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"bafc4055-e594-43c8-8b11-6a9fba9a75f7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594593920917,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594593920921,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Create or update Gateway QoS profile",
"description": "If profile with the qos-profile-id is not already present,\ncreate a new gateway QoS profile instance. If it already exists, replace\nthe gateway QoS profile instance with this object.\n",
"operationId": "GlobalInfraCreateOrReplaceGatewayQosProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n{\n \"committed_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"committed_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\",\n \"resource_type\": \"GatewayQosProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"profile1\",\n \"path\": \"/infra/gateway-qos-profiles/profile1\",\n \"relative_path\": \"profile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"bafc4055-e594-43c8-8b11-6a9fba9a75f7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594593920917,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594593920921,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "GatewayQosProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Delete gateway QoS profile",
"description": "Delete QoS profile",
"operationId": "GlobalInfraDeleteGatewayQosProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Create or update Gateway QoS profile",
"description": "If profile with the qos-profile-id is not already present,\ncreate a new gateway QoS profile instance. If it already exists, update\nthe gateway QoS profile instance with specified attributes.\n",
"operationId": "GlobalInfraPatchGatewayQosProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n{\n \"commited_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "GatewayQosProfile"
}
},
"/global-infra/dhcp-relay-configs": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Relay Configs"
],
"summary": "List DHCP relay config instances",
"description": "Paginated list of all DHCP relay config instances\n",
"operationId": "GlobalInfraListDhcpRelayConfig",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpRelayConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-relay-configs\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"DhcpRelayConfig\",\n \"id\": \"dhcp-relay1\",\n \"display_name\": \"dhcp-relay1\",\n \"path\": \"/infra/dhcp-relay-configs/dhcp-relay1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"dhcp-relay1\",\n \"server_addresses\": [ \"10.1.1.1\", \"10.1.1.2\" ]\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668826912,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668826912,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/firewall-identity-stores/{firewall-identity-store-id}/org-units": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Fetch all organization units for a Firewall Identity Store.",
"description": "Fetch all organization units for a Firewall Identity Store.",
"operationId": "FetchFirewallIdentityStoreOrgUnitsForIdentityStore",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity Store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryOrgUnitListResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://{{NSX}}/policy/api/v1/infra/firewall-identity-stores/store-1/org-units\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"name\": \"Domain Controllers\",\n \"distinguished_name\": \"OU=Domain Controllers,DC=idfw,DC=local\"\n }\n ],\n \"result_count\": 1\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Get L2VPN service under Tier-1",
"description": "Get L2VPN service for given Tier-1.",
"operationId": "GetTier1VpnL2VPNService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-1s/cgw/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Create or fully replace L2VPN service under Tier-1",
"description": "Create or fully replace L2VPN service for given Tier-1. Revision is optional for creation and required for update.",
"operationId": "CreateOrUpdateTier1VpnL2VPNService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n{\n \"enable_hub\" : true,\n \"_revision\" : 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-0s/ext_net/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "L2VPNService"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Delete L2VPN service under Tier-1",
"description": "Delete L2VPN service for given Tier-1.",
"operationId": "DeleteTier1VpnL2VPNService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Create or patch L2VPN service under Tier-1",
"description": "Create or patch L2VPN service for given Tier-1.",
"operationId": "CreateOrPatchTier1VpnL2VPNService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n{\n \"enable_hub\": true,\n}\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-codegen-request-body-name": "L2VPNService"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-context/l2vpns": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "List L2Vpns",
"description": "Paginated list of L2Vpns.\nThis API is deprecated. Please use GET /infra/tier-0s//locale-services/\n/l2vpn-services/default/sessions instead.\nIf used, this deprecated API will only return L2Vpns that were created through the deprecated\nPATCH and PUT /infra/tier-0s//locale-services//l2vpn-context/\nl2vpns/ APIs.\n",
"operationId": "ListL2Vpns",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VpnListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/l2vpn-context/l2vpns\n",
"x-vmw-nsx-module": "PolicyL2Vpn",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"L2Vpn\",\n \"id\": \"pa-pune-l2vpn\",\n \"display_name\": \"pa-pune-l2vpn\",\n \"path\": \"/infra/tier-0s/vmc/locale-services/default/l2vpn-services/default/sessions/L2VPN_pa-pune-l2vpn\",\n \"parent_path\": \"/infra/tier-0s/vmc/locale-services/default/l2vpn-services/default\",\n \"relative_path\": \"pa-pune-l2vpn\",\n \"transport_tunnels\": [\n \"/infra/tier-0s/vmc/locale-services/default/ipsec-vpn-services/default/sessions/L3VPN_pa-pune-rb-vpn\"\n ],\n \"enabled\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/sha/plugin-profiles": {
"get": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "API will provide list of SHA profiles.",
"description": "API will provide list of SHA profiles.\n",
"operationId": "ListShaPluginProfiles",
"parameters": [
{
"name": "applied_to_group_path",
"in": "query",
"description": "The path of the Policy group object",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "plugin_path",
"in": "query",
"description": "String path of the Sha plugin",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPluginProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sha/plugin-profiles\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n\"sort_ascending\": true,\n\"sort_by\": \"display_name\",\n\"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"ShaPluginProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"/infra/sha/plugin-profiles/profile1\",\n \"path\": \"/infra/sha/plugin-profiles/profile1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile1\",\n \"plugin_path\": \"/infra/sha/pre-defined-plugins/daemon-health\",\n \"plugin_type\": \"PredefinedPlugin\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n \"enabled\": true,\n \"config\": {\n \"check_interval\": 30,\n \"report_interval\": 180,\n \"smallest_report_interval_if_change\": 60\n }\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/federation-config": {
"get": {
"tags": [
"Federation",
"Federation Configuration"
],
"summary": "Read federation config",
"description": "Read a federation config from Global Manager.",
"operationId": "ReadFederationConfig",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FederationConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/global-infra/federation-config\nGET https://<global-mgr>/global-manager/api/v1/global-infra/federation-config\n",
"x-vmw-nsx-module": "PolicySiteGM",
"x-vmw-nsx-example-response": "{\n \"site_config\" : [\n {\n \"site_id\": \"59ee0369-3d2b-4b2a-9221-594344f6ca4c\",\n \"rtep_ips\": [\n \"10.192.201.163\",\n \"10.192.201.164\"\n ],\n \"site_index\": 1,\n \"site_path\": \"/global-infra/sites/paris\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/aaa/user-info": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Users"
],
"summary": "Get the name and role information of the user.",
"description": "This API will return the name and role information of the user\ninvoking this API request on the particular project.\nThe permissions parameter of the NsxRole has been deprecated.\nThe response will contain the roles_for_paths to indicate roles\nof the user at various paths .\n",
"operationId": "GetMultitenantCurrentUserInfoVPC",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/org/default/projects/project-1/vpcs/vpc-1/aaa/user-info\n",
"x-vmw-nsx-module": "PolicyMultitenancyAuthorization",
"x-vmw-nsx-example-response": "{\n \"user_name\": \"johndoe@abc.com\",\n \"roles_for_paths\": [\n {\n \"path\": \"/orgs/default/projects/project-1\",\n \"roles\": [\n {\n \"role\": \"security_engineer\",\n \"role_display_name\": \"Security Admin\"\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/aaa/role-bindings/{binding-id}": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Get user/group's role information from CSP",
"description": "Get user/group's role information from CSP",
"operationId": "GetRoleBindingMultitenancyProject",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_id",
"in": "query",
"description": "Identity source ID",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_type",
"in": "query",
"description": "Identity source type",
"schema": {
"type": "string",
"enum": [
"VIDM",
"LDAP",
"OIDC"
]
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "User/Group name",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "path",
"in": "query",
"description": "Exact path of the context",
"schema": {
"type": "string"
}
},
{
"name": "role",
"in": "query",
"description": "Role ID",
"schema": {
"type": "string"
}
},
{
"name": "root_path",
"in": "query",
"description": "Prefix path of the context",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type",
"schema": {
"type": "string",
"enum": [
"remote_user",
"remote_group",
"local_user",
"principal_identity"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleBinding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/aaa/role-bindings/7e672b0e-f0bd-48bc-b579-9e6f1b2b3969\n",
"x-vmw-nsx-module": "PolicyMultitenancyAuthorization",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"RoleBinding\",\n \"description\": \"\",\n \"id\": \"7e672b0e-f0bd-48bc-b579-9e6f1b2b3969\",\n \"display_name\": \"johndoe@abc.com\",\n \"roles\": [\n {\n \"role\": \"enterprise_admin\"\n }\n ],\n \"name\": \"johndoe@abc.com\",\n \"type\": \"remote_user\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1493960803006,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1493960803006,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"delete": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Delete user/group's roles assignment",
"description": "Delete the user/group's role assignment on CSP. If the path is provided\nthen deletes only the roles_for_paths that matches the path. If\npath is provided for the last roles_for_paths then the whole role\nbinding is deleted provided it is not that of a local user.\n",
"operationId": "DeleteRoleBindingMultitenancyProject",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_id",
"in": "query",
"description": "Identity source ID",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_type",
"in": "query",
"description": "Identity source type",
"schema": {
"type": "string",
"enum": [
"VIDM",
"LDAP",
"OIDC"
]
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "User/Group name",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "path",
"in": "query",
"description": "Exact path of the context",
"schema": {
"type": "string"
}
},
{
"name": "role",
"in": "query",
"description": "Role ID",
"schema": {
"type": "string"
}
},
{
"name": "root_path",
"in": "query",
"description": "Prefix path of the context",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type",
"schema": {
"type": "string",
"enum": [
"remote_user",
"remote_group",
"local_user",
"principal_identity"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/api/v1/aaa/role-bindings/5c669dc6-47a8-4508-3077-6a48f26c5a4g\n",
"x-vmw-nsx-module": "PolicyMultitenancyAuthorization",
"x-vmw-nsx-example-response": "200 OK"
}
},
"/infra/metadata-proxies/{metadata-proxy-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Metadata Proxy",
"Status"
],
"summary": "Get metadata proxy status",
"description": "Get metadata proxy status",
"operationId": "ReadMetadataProxyStatus",
"parameters": [
{
"name": "metadata-proxy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "segment_path",
"in": "query",
"description": "String Path of the segment which is associated with this metadata proxy",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyMetadataProxyStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/api/v1/md-proxies/8966db98-e2ca-4757-af3b-330755ca3e94/6b169af5-4579-481d-a886-9ef7846a7603/status\n",
"x-vmw-nsx-module": "PolicyMetadataProxy",
"x-vmw-nsx-example-response": "{\n \"transport_nodes\": [\n \"12176406-a7c9-11ea-8166-020063c85974\",\n \"a831390e-a7c8-11ea-9102-020063e79023\"\n ],\n \"proxy_status\": \"DOWN\",\n \"error_message\": \"ErrorCode: INTERNAL_ERROR, Detail: backend nova server connection is broken with reason: UNKNOWN;; ErrorCode: INTERNAL_ERROR, Detail: backend nova server connection is broken with reason: UNKNOWN;\"\n}\n"
}
},
"/infra/nvds-urt/topology?action=apply": {
"put": {
"tags": [
"System Administration",
"Lifecycle Management",
"Migration",
"NVDS"
],
"summary": "Set VDS configuration and create it in vCenter",
"description": "Set VDS configuration and create it in vCenter\n
\nNVDS-to-CVDS Upgrade Readiness Tool feature won't be supported",
"operationId": "PolicySetTargetVdsTopology",
"parameters": [
{
"name": "cluster_id",
"in": "query",
"description": "cluster identifier",
"schema": {
"type": "string"
}
},
{
"name": "use_recommended_topology_config",
"in": "query",
"description": "Flag to indicate if use recommended topology got from the latest precheck",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpgradeTopology"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpgradeTopology"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/nvds-urt/topology?action=apply\n{\n \"topology\": [\n {\n \"nvds_id\": \"bb 23 24 9d e4 0a 4c 62-91 9b 77 66 55 29 4c 92\",\n \"nvds_name\": \"mynvds1\",\n \"compute_manager_topology\": [\n {\n \"compute_manager_id\": \"ddb8efeb-581e-435a-93b7-f95da399d7e0\",\n \"dvswitch\": [\n {\n \"data_center_id\": \"domain-c8:70dade9c-eaf2-462b-9005-7ecf14595c19\",\n \"vds_name\": \"myvds1\",\n \"transport_node_id\": [\"674007b3-5671-4409-911f-1c191ef492f7\"]\n }\n ]\n }\n ]\n }\n ]\n\n}\n",
"x-vmw-nsx-module": "PolicyNvdsUpgradeReadinessCheck",
"x-vmw-nsx-example-response": "{\n \"topology\": [\n {\n \"nvds_id\": \"bb 23 24 9d e4 0a 4c 62-91 9b 77 66 55 29 4c 92\",\n \"nvds_name\": \"mynvds1\",\n \"compute_manager_topology\": [\n {\n \"compute_manager_id\": \"ddb8efeb-581e-435a-93b7-f95da399d7e0\",\n \"dvswitch\": [\n {\n \"data_center_id\": \"domain-c8:70dade9c-eaf2-462b-9005-7ecf14595c19\",\n \"vds_name\": \"myvds1\",\n \"transport_node_id\": [\n \"674007b3-5671-4409-911f-1c191ef492f7\"\n ]\n }\n ]\n }\n ]\n }\n ]\n}\n",
"x-codegen-request-body-name": "UpgradeTopology"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/segment-ports": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get segment ports that belong to this Group",
"description": "Get segment ports that belong to this Group\n",
"operationId": "GetGroupSegmentPortMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/segment-ports?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"id\": \"default:4a5a3cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"nbokare-10.160.129.166-vdtest-97902/VM-1-10.160.129.166-20190505-122351-03783733@b089f7e1-433f-4ecc-9722-ab5f2b66d391\",\n \"path\": \"/infra/segments/segment-1/ports/default:4a5a3cd0-6f0a-40b0-a31a-1f55d51e1824\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/enforcement-points/{enforcement-point-id}/service-definitions/{service-definition-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Definitions"
],
"summary": "Read Service Definition with given service-definition-id.",
"description": "Read Service Definition with given service-definition-id.\n",
"operationId": "ReadServiceDefinition",
"parameters": [
{
"name": "enforcement-point-id",
"in": "path",
"description": "Enforcement point id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-definition-id",
"in": "path",
"description": "Id of service definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/enforcement-points/default/service-definitions/4727f325-f362-4bd6-8006-961dfd3eca32\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\":\"ServiceDefinition\",\n \"description\":\"NS-Service\",\n \"id\":\"748be482-a072-4f26-b707-d6e68fc0de16\",\n \"display_name\":\"NS Service_for_VMC\",\n \"tags\":[\n {\n \"scope\":\"\",\n \"tag\":\"/infra/tier-0s/vmc/locale-services/default/service-instances/PSI-1\"\n }\n ],\n \"attachment_point\":[\n \"TIER0_LR\"\n ],\n \"transports\":[\n \"L2_BRIDGE\"\n ],\n \"functionalities\":[\n \"NG_FW\"\n ],\n \"on_failure_policy\":\"ALLOW\",\n \"implementations\":[\n \"NORTH_SOUTH\"\n ],\n \"_create_user\":\"nsx_policy\",\n \"_create_time\":1522353953977,\n \"_last_modified_user\":\"nsx_policy\",\n \"_last_modified_time\":1522353953977,\n \"_system_owned\":false,\n \"_protection\":\"PROTECTED\",\n \"_revision\":1\n }\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Definitions"
],
"summary": "Update an existing Service Definition on the given enforcement point\n",
"description": "Update an existing Service Definition on the given enforcement point.\n",
"operationId": "UpdateServiceDefinition",
"parameters": [
{
"name": "enforcement-point-id",
"in": "path",
"description": "Enforcement point id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-definition-id",
"in": "path",
"description": "Id of service definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceDefinition"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/enforcement-points/default/service-definitions/<sd-id>\n{\n \"resource_type\": \"ServiceDefinition\",\n \"description\": \"NS-Service Changed Desc\",\n \"display_name\": \"NS Service_for_VMC\",\n \"tags\":[\n {\n \"scope\": \"\",\n \"tag\": \"/infra/tier-0s/vmc/locale-services/default/service-instances/PSI-1\"\n }\n ],\n \"attachment_point\": [\n \"TIER0_LR\"\n ],\n \"transports\": [\n \"L2_BRIDGE\"\n ],\n \"functionalities\": [\n \"NG_FW\"\n ],\n \"on_failure_policy\" :\"ALLOW\",\n \"implementations\": [\n \"NORTH_SOUTH\"\n ],\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ServiceDefinition\",\n \"description\": \"NS-Service Changed Desc\",\n \"id\": ,\n \"display_name\": \"NS Service_for_VMC\",\n \"tags\": [\n {\n \"scope\":\"\",\n \"tag\":\"/infra/tier-0s/vmc/locale-services/default/service-instances/PSI-1\"\n }\n ],\n \"attachment_point\": [\n \"TIER0_LR\"\n ],\n \"transports\": [\n \"L2_BRIDGE\"\n ],\n \"functionalities\": [\n \"NG_FW\"\n ],\n \"on_failure_policy\": \"ALLOW\",\n \"implementations\": [\n \"NORTH_SOUTH\"\n ],\n \"_create_user\": \"nsx_policy\",\n \"_create_time\": 1522353953977,\n \"_last_modified_user\": \"nsx_policy\",\n \"_last_modified_time\": 1522353953977,\n \"_system_owned\": false,\n \"_protection\": \"PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "ServiceDefinition"
},
"delete": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Definitions"
],
"summary": "Delete an existing Service Definition on the given enforcement point\n",
"description": "Delete an existing Service Definition on the given enforcement point.\n",
"operationId": "DeleteServiceDefinition",
"parameters": [
{
"name": "enforcement-point-id",
"in": "path",
"description": "Enforcement point id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-definition-id",
"in": "path",
"description": "Id of service definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/enforcement-points/default/service-definitions/4727f325-f362-4bd6-8006-961dfd3eca32\n",
"x-vmw-nsx-module": "PolicyServiceInsertion"
}
},
"/infra/realized-state/enforcement-points/{enforcement-point-name}/groups/nsgroups": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "List NS Groups",
"description": "Paginated list of all NSGroups. Returns populated NSGroups.\n",
"operationId": "ListNSGroupRealizedStates",
"parameters": [
{
"name": "enforcement-point-name",
"in": "path",
"description": "Enforcement Point Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericPolicyRealizedResourceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyRealizedState"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Status"
],
"summary": "Get L2VPN session detailed status under Tier-0",
"description": "- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.\n- an enforcement point path is specified: detailed status is evaluated only on the given\nenforcement point.\n- source=realtime: detailed tatus is fetched realtime from the enforcement point.\n- source=cached: cached detailed status is returned.\n\n
\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/\nsessions/<session-id>/detailed-status instead.\n",
"operationId": "GetL2VpnSessionStatus",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VPNSessionStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/locale-services/default/l2vpn-services/default/sessions/stretched-pa-site/detailed-status\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/segments/{segment-id}/segment-security-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "List infra segment security profile binding maps",
"description": "API will list all segment security profile binding maps.\n",
"operationId": "ListInfraSegmentSecurityProfileBindings",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/segment-security-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentSecurityProfileBindingMap\",\n \"id\": \"segment_security_binding_map_1\",\n \"display_name\": \"segment_security_binding_map_1\",\n \"path\": \"/infra/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\",\n \"parent_path\": \"/infra/segments/segment_1\",\n \"relative_path\": \"segment_security_binding_map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539129491798,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129739799,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/static-routes/{route-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes"
],
"summary": "Read Tier-0 static routes",
"description": "Read Tier-0 static routes",
"operationId": "GlobalInfraReadTier0StaticRoutes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/static-routes/site1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"StaticRoutes\",\n \"id\": \"site1\",\n \"display_name\": \"/infra/tier-0s/vmc_prv/static-routes/site1\",\n \"path\": \"/infra/tier-0s/vmc_prv/static-routes/site1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"site1\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"network\": \"45.1.1.0/24\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516750267338,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516750267338,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes"
],
"summary": "Create or update a Tier-0 static routes",
"description": "If static routes for route-id are not already present, create\nstatic routes. If it already exists, replace the static routes for route-id.\n",
"operationId": "GlobalInfraCreateOrReplaceTier0StaticRoutes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/static-routes/site1\n{\n \"network\": \"45.1.1.0/24\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"StaticRoutes\",\n \"id\": \"site1\",\n \"display_name\": \"/infra/tier-0s/vmc_prv/static-routes/site1\",\n \"path\": \"/infra/tier-0s/vmc_prv/static-routes/site1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"site1\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"network\": \"45.1.1.0/24\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516750267338,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516750267338,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "StaticRoutes"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-proxy?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments"
],
"summary": "Get downlink port Address Resolution Protocol Proxies for infra segment in CSV format",
"description": "Returns ARP proxy table for downlink port on connected to the segment in CSV format\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetDownlinkPortArpProxiesForInfraSegmentInCsv",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/segments/test-segment/arp-proxy?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "TODO smanikarnike\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/pcaps": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "List IDS PCAP file metadata",
"description": "List IDS PCAP file metadata.\nCurrently this is a node specific API and it will return the list\nof PCAP metadata for a specific node.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIdsPcapFiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsPcapFileMetadataListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": ""
}
},
"/global-infra/spoofguard-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Spoofguard Profiles"
],
"summary": "List SpoofGuard profiles",
"description": "API will list all SpoofGuard profiles.\n",
"operationId": "GlobalInfraListSpoofGuardProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpoofGuardProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/spoofguard-profiles/\n",
"x-vmw-nsx-module": "PolicySpoofGuard",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"SpoofGuardProfile\",\n \"id\": \"default-spoofguard-profile\",\n \"display_name\": \"default-spoofguard-profile\",\n \"path\": \"/infra/spoofguard-profiles/default-spoofguard-profile\",\n \"parent_path\": \"/infra/spoofguard-profiles/default-spoofguard-profile\",\n \"relative_path\": \"default-spoofguard-profile\",\n \"marked_for_delete\": false,\n \"address_binding_allowlist\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1539118620552,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1539118620552,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"SpoofGuardProfile\",\n \"id\": \"spoofguardprofile_1\",\n \"display_name\": \"spoofguardprofile_1\",\n \"path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"parent_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"relative_path\": \"spoofguardprofile_1\",\n \"marked_for_delete\": false,\n \"address_binding_allowlist\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1539128784467,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539128784467,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/realized-state/status": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "Get consolidated status of an intent object",
"description": "Get Consolidated Status of an intent object (with or without enforcement specific status details).\nThe request is evaluated as follows:\n- <intent_path>: the request is evaluated on all enforcement points for the given intent without\nenforcement point specific details.\n- <intent_path, include_enforced_status>: the request is evaluated on all enforcement points for\nthe given intent with enforcement point specific details.\n",
"operationId": "GlobalInfraReadIntentStatus",
"parameters": [
{
"name": "include_enforced_status",
"in": "query",
"description": "Include Enforced Status Flag",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "intent_path",
"in": "query",
"description": "Policy Path of the intent object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "site_path",
"in": "query",
"description": "Policy Path of the site from where the realization status needs to be fetched",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolidatedRealizedStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/realized-state/status?intent_path=/infra/domains/default/security-policies/block-external&include_enforced_status=true\n",
"x-vmw-nsx-module": "PolicyRealizedState",
"x-vmw-nsx-example-response": "{\n \"consolidated_status\": {\n \"consolidated_status\": \"ERROR\"\n },\n \"consolidated_status_per_enforcement_point\": [\n {\n \"enforced_status\": {\n \"enforced_status_info\": {\n \"enforced_status\": {\n \"status\": \"UNKNOWN\"\n },\n \"enforced_status_per_scope\": [\n {\n \"enforced_status_per_transport_node\": [\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/c578e7ba-5ce5-11e9-acec-41d19997391c\",\n \"enforced_status\": {\n \"status\": \"FAILURE\",\n \"status_message\": \"Internal error(1101) occurred on transport node c578e7ba-5ce5-11e9-acec-41d19997391c.\"\n }\n },\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/a744cd7e-5ce5-11e9-a24b-df71fdc87f85\",\n \"enforced_status\": {\n \"status\": \"SUCCESS\"\n }\n },\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/77af8e10-5ce5-11e9-9149-5bb770f7c6c7\",\n \"enforced_status\": {\n \"status\": \"SUCCESS\"\n }\n },\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/93ecd452-5ce5-11e9-8c18-bdce5885e998\",\n \"enforced_status\": {\n \"status\": \"SUCCESS\"\n }\n }\n ],\n \"resource_type\": \"TransportNodeSpanEnforcedStatus\"\n }\n ]\n },\n \"pending_changes_info\": {\n \"pending_changes_flag\": false\n }\n },\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"enforcement_point_id\": \"default\",\n \"consolidated_status\": {\n \"consolidated_status\": \"UNKNOWN\"\n }\n }\n ],\n \"intent_path\": \"/infra/domains/default/security-policies/block-external\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"NAT",
"Statistics"
],
"summary": "Get NAT Rule Statistics",
"description": "Get NAT Rule Statistics from Tier-1 denoted by Tier-1 ID, under NAT section\ndenoted by <nat-id>.\nUnder tier-1 there will be 3 different NATs(sections).\n(INTERNAL, USER and DEFAULT)\nFor more details related to NAT section please refer to PolicyNAT schema.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPolicyNatRuleStatisticsFromTier1",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action on statistics",
"schema": {
"type": "string",
"enum": [
"aggregate"
]
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyNatRuleStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyNAT",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"rule_path\": \"/infra/tier-1s/network/nat/USER/nat-rules/1\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"rule_statistics\": [\n {\n \"total_bytes\": 0,\n \"active_sessions\": 0,\n \"total_packets\": 0,\n \"last_update_timestamp\": 1537502752201\n },\n {\n \"total_bytes\": 0,\n \"active_sessions\": 0,\n \"total_packets\": 0,\n \"last_update_timestamp\": 1537502753915\n }\n ]\n }\n ]\n }\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get statistics for downlink router port on tier-1 router",
"description": "Segment ID is the ID of the segment that is connected to the the tier-1\n",
"operationId": "GlobalInfraGetDownlinkPortStatisticsForTier1Segment",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH/gateway-interface-statistics?edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/7f7d37a7-b78e-4378-949d-09190cbfef7d/edge-nodes/a831390e-a7c8-11ea-9102-020063e79023\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_router_port_id\": \"/infra/tier-1s/TLR1_LR\",\n \"per_node_statistics\": [\n {\n \"last_update_timestamp\": 1591806707306,\n \"rx\": {\n \"total_bytes\": 78780,\n \"total_packets\": 1313,\n \"dropped_packets\": 94459\n },\n \"tx\": {\n \"total_bytes\": 57559796,\n \"total_packets\": 813354,\n \"dropped_packets\": 94459\n }\n }\n ]\n}\n"
}
},
"/infra/l7-access-profiles": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "List l7 access Profiles",
"description": "API will list all l7 access Profiles",
"operationId": "ListL7AccessProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_entry_count",
"in": "query",
"description": "Include the count of entries in L7 Profile",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/l7-access-profiles\n",
"x-vmw-nsx-module": "L7AccessProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"l7_access_entries\": [\n {\n \"sequence_number\": 100,\n \"attributes\": [\n {\n \"key\": \"APP_ID\",\n \"value\": [\n \"SSL\"\n ],\n \"datatype\": \"STRING\",\n \"sub_attributes\": [\n {\n \"key\": \"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\": \"STRING\"\n },\n {\n \"key\": \"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\": \"STRING\"\n }\n ],\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_0\",\n \"display_name\": \"entry_0\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_0\",\n \"relative_path\": \"entry_0\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"realization_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431167,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431167,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 101,\n \"attributes\": [\n {\n \"key\": \"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": false,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_1\",\n \"display_name\": \"entry_1\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_1\",\n \"relative_path\": \"entry_1\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"realization_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431168,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431168,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 102,\n \"attributes\": [\n {\n \"key\": \"URL_CATEGORY\",\n \"value\": [\n \"Auctions\",\n \"Abused Drugs\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_2\",\n \"display_name\": \"entry_2\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_2\",\n \"relative_path\": \"entry_2\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"realization_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431169,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431169,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 103,\n \"attributes\": [\n {\n \"key\": \"URL_REPUTATION\",\n \"value\": [\n \"Suspicious\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT_WITH_RESPONSE\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_3\",\n \"display_name\": \"entry_3\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_3\",\n \"relative_path\": \"entry_3\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"realization_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431171,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431171,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"user_response_message\": \"\",\n \"default_action\": \"REJECT\",\n \"default_action_logged\": false,\n \"resource_type\": \"L7AccessProfile\",\n \"id\": \"profile-1\",\n \"display_name\": \"profile-1\",\n \"description\": \"Test Policy L7 Access Profile\",\n \"path\": \"/infra/l7-access-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"realization_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431163,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431163,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/member-types": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get member types for a given Group",
"description": "It retrieves member types for a given group. In case of nested groups, it calculates\nmember types of child groups as well. Considers member type for members added\nvia static members and dynamic membership criteria.\n",
"operationId": "GetMemberTypesForGroup",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupMemberTypeListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/groups/webgroup/member-types\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resultCount\": 1,\n \"results\" : [\"VirtualMachine\"]\n}\n"
}
},
"/infra/routing-config/prefix-lists": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Routing",
"Prefix List"
],
"summary": "List prefix lists",
"description": "Paginated list of all prefix lists\n",
"operationId": "ListInfraPrefixLists",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrefixListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/routing-config/prefix-lists\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PrefixList\",\n \"id\": \"to-onprem\",\n \"display_name\": \"/infra/routing-config/prefix-lists/to-onprem\",\n \"path\": \"/infra/routing-config/prefix-lists/to-onprem\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"to-onprem\",\n \"marked_for_delete\": false,\n \"prefixes\": [\n {\n \"action\": \"PERMIT\",\n \"network\": \"30.1.1.0/24\"\n },\n {\n \"action\": \"DENY\",\n \"network\": \"10.1.1.0/24\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1525754971782,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1525755003657,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "List Segment Monitoring Profile Binding Maps",
"description": "API will list all Segment Monitoring Profile Binding Maps in current segment id.\n",
"operationId": "ListSegmentMonitoringBindings",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMonitoringProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentMonitoringProfileBindingMap\",\n \"description\": \"\",\n \"name\":\"1\",\n \"id\":\"1\",\n \"display_name\": \"SegmentMonitoringProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1\",\n \"relative_path\": \"SegmentMonitoringProfileBindingMaps\",\n \"port_mirroring_profile_path\":\"/infra/port-mirroring-profiles/1\",\n \"ipfix_l2_profile_path\":\"/infra/ipfix-l2-profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"DAD State"
],
"summary": "Get DAD status by interface",
"description": "Get tier-0 interface DAD state information.\n",
"operationId": "GetTier0InterfaceDADState",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceDADState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1//infra/tier-0s/pepsi/locale-services/default/interfaces/to_internet/dad-state?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_path\": \"/infra/tier-0s/pepsi/locale-services/default/interfaces/to_internet\",\n \"dad_statuses\": [\n {\n \"ip_address\": \"2001::1\",\n \"status\": \"ASSIGNED\",\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-point/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd/edge-nodes/940f1f4b-0317-45d4-84e2-b8c2394e7405\"\n ]\n }\n ]\n}\n"
}
},
"/infra/realized-state/alarms": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "List All alarms in the system",
"description": "Paginated list of all alarms.\n",
"operationId": "ListAlarms",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyAlarmResourceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/realized-state/alarms\n",
"x-vmw-nsx-module": "PolicyRealizedState",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PolicyAlarmResource\",\n \"id\": \"PROVIDER_INVOCATION_FAILURE\",\n \"display_name\": \"e88f4514-fd2d-4e91-b4b7-e8c9f594ae49\",\n \"parent_path\": \"*/alarms/realized-state\",\n \"relative_path\": \"e88f4514-fd2d-4e91-b4b7-e8c9f594ae49\",\n \"message\": \"I/O error on POST request for \\\"http://127.0.0.1:7440/nsxapi/api/v1/firewall/sections\\\": Connect to 127.0.0.1:7440 [/127.0.0.1] failed: Connection refused (Connection refused); nested exception is org.apache.http.conn.HttpHostConnectException: Connect to 127.0.0.1:7440 [/127.0.0.1] failed: Connection refused (Connection refused)\",\n \"source_reference\": \"/infra/realized-state/enforcement-points/default/firewalls/firewall-sections/7f4ce9e1-e1d9-11e8-8ce3-f56aad4808c4.38989010-e1db-11e8-8ce3-f56aad4808c4\",\n \"_create_user\": \"system\",\n \"_create_time\": 1541519266261,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1541519266261,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/napp/deployment/tools/upload/status/{bundle-id}": {
"get": {
"tags": [
"NSX Application Platform",
"Deployment",
"Bundle",
"Status"
],
"summary": "Get progress status of kubernetes tools bundle upload",
"description": "Get the progress of uploading kubernetes tools bundle from the remote location.\nThis API will also verify the kubernetes tools bundle, before marking upload as a success.\n",
"operationId": "GetUploadBundleStatus",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bundle-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadBundleStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/napp/deployment/tools/upload/status/22000123456\n",
"x-vmw-nsx-module": "PolicyCloudNative",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"UploadBundleStatus\",\n \"port\" : 80,\n \"server\": \"192.168.120.151\",\n \"uri\" : \"/custom/path/container_tools_22000123456.tar.gz\",\n \"protocol\" : \"https\"\n \"percent\" : 80,\n \"status\" : \"VERIFYING\",\n \"detailed_status\": \"Checking Signature of the Upgrade Bundle\"\n}\n"
}
},
"/global-infra/domains/{domain-id}/groups/{group-id}/members/ip-groups": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Effective IPGroups that belong to this group.",
"description": "Returns effective IPGroups that belong to this group.\nThis API is applicable only for Groups containing IPSet member type.\nFor Groups containing other member types,it returns an empty list.\n",
"operationId": "GlobalInfraGetGroupIPAddressGroupMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/ip-groups?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"cursor\": \"00361f148bdc-fe7c-4320-8ef3-594e28d57c87Iws-2\",\n \"sort_ascending\": true,\n \"result_count\": 2,\n \"results\": [\n {\n \"target_id\" : \"fcb51d1d-b141-4f5b-a0b9-1063a1470a63\",\n \"target_display_name\" : \"IPSet1\",\n \"target_type\" : \"IPSet\",\n },\n {\n \"id\" : \"3eecac54-15e7-4a0d-b418-001052fcfdcd\",\n \"display_name\" : \"IPSet2\",\n \"target_type\" : \"IPSet\"\n }\n ]\n }\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "Read Tier 1 service interface",
"description": "Read Tier 1 service interface",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadTier1ServiceInterface",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInterface"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/service-interfaces/to_internet\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ServiceInterface\",\n \"id\": \"to_internet\",\n \"display_name\": \"to_internet\",\n \"path\": \"/infra/tier-1s/TLR1/locale-services/default/service-interfaces/to_internet\",\n \"parent_path\": \"/infra/tier-1s/TLR1/locale-services/default\",\n \"relative_path\": \"to_internet\",\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "Create a Tier1 service interface",
"description": "If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service\ninterface. Modification of Tier 1 service interface is not allowed.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateTier1ServiceInterface",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInterface"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInterface"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/service-interfaces/to_internet\n{\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ServiceInterface\",\n \"id\": \"to_internet\",\n \"display_name\": \"to_internet\",\n \"path\": \"/infra/tier-1s/TLR1/locale-services/default/service-interfaces/to_internet\",\n \"parent_path\": \"/infra/tier-1s/TLR1/locale-services/default\",\n \"relative_path\": \"to_internet\",\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "ServiceInterface"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "Delete Tier 1 service interface",
"description": "Delete Tier 1 service interface",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTier1ServiceInterface",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/service-interfaces/to_internet\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "Create or update a Tier-1 service interface",
"description": "If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service\ninterface.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchTier1ServiceInterface",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInterface"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/service-interfaces/to_internet\n{\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "ServiceInterface"
}
},
"/global-infra/tier-1s/{tier-1-id}/advertised-networks/csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Routing"
],
"summary": "List advertised networks in CSV format",
"description": "Return networks which are advertised to connected TIER0 gateway in CSV format.\n",
"operationId": "GlobalInfraGetTier1AdvertisedNetworksInCsvFormat",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyAdvertisedNetworkInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s//advertised-networks/csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Route Maps"
],
"summary": "Read a route map",
"description": "Read a route map",
"operationId": "GetRouteMap",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0RouteMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/route-maps/rm1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"RoueMap\",\n \"id\": \"rm1\",\n \"display_name\": \"rm1\",\n \"path\": \"/infra/tier-0s/vmc_prv/route-maps/rm1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"rm1\",\n \"entries\": [\n {\n \"community_list_matches\": [\n {\n \"criteria\": \"/infra/tier-0s/vmc/community-lists/cl1\",\n \"match_operator\": \"MATCH_ALL\"\n }],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n },\n {\n \"prefix_list_matches\": [ \"/infra/tier-0s/vmc/prefix-lists/pl1\" ],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Route Maps"
],
"summary": "Create or update a route map",
"description": "If a route map with the route-map-id is not already present,\ncreate a new route map. If it already exists, replace the\nroute map instance with the new object.\n",
"operationId": "CreateOrReplaceRouteMap",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0RouteMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0RouteMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/route-maps/rm1\n{\n \"entries\": [\n {\n \"community_list_matches\": [\n {\n \"criteria\": \"/infra/tier-0s/vmc/community-lists/cl1\",\n \"match_operator\": \"MATCH_ALL\"\n }],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n },\n {\n \"prefix_list_matches\": [ \"/infra/tier-0s/vmc/prefix-lists/pl1\" ],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n }\n ],\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Tier0RoueMap\",\n \"id\": \"rm1\",\n \"display_name\": \"rm1\",\n \"path\": \"/infra/tier-0s/vmc_prv/route-maps/rm1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"rm1\",\n \"entries\": [\n {\n \"community_list_matches\": [\n {\n \"criteria\": \"/infra/tier-0s/vmc/community-lists/cl1\",\n \"match_operator\": \"MATCH_ALL\"\n }],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n },\n {\n \"prefix_list_matches\": [ \"/infra/tier-0s/vmc/prefix-lists/pl1\" ],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "Tier0RouteMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Route Maps"
],
"summary": "Delete a route map",
"description": "Delete a route map",
"operationId": "RemoveRouteMap",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/route-maps/rm1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Route Maps"
],
"summary": "Create or update a route map",
"description": "If a route map with the route-map-id is not already present, create a new\nroute map. If it already exists, update the route map for specified\nattributes.\n",
"operationId": "PatchRouteMap",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0RouteMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/route-maps/rm1\n{\n \"entries\": [\n {\n \"community_list_matches\": [\n {\n \"criteria\": \"/infra/tier-0s/vmc/community-lists/cl1\",\n \"match_operator\": \"MATCH_ALL\"\n }],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n },\n {\n \"prefix_list_matches\": [ \"/infra/tier-0s/vmc/prefix-lists/pl1\" ],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "Tier0RouteMap"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/security-policies": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "List security policies",
"description": "List all security policies for a domain.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListSecurityPoliciesForDomain",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"SecurityPolicy\",\n \"description\": \"comm map\",\n \"id\": \"application-section-1\",\n \"display_name\": \"application-section-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"application-section-1\",\n \"category\": \"Application\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 13000000,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"security-policy\",\n \"display_name\": \"security-policy\",\n \"path\": \"/infra/domains/vmc/security-policies/security-policy\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"security-policy\",\n \"sequence_number\": 100,\n \"internal_sequence_number\": 13000100,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517307910504,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517307910504,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-0 router link statistics summary information",
"description": "Get tier-0 router link statistics summary information. In case tier 1 is A/A, and the edge cluster is not\nthe response will have interface_policy_path and logical_router_port_id empty because all logical router \nport stats are aggregated from all edge nodes.\n",
"operationId": "GetTier0RouterLinkSummaryStatistics",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "tier1_path",
"in": "query",
"description": "Policy path of tier1",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatisticsSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/pepsi/tier-1-interface/statistics/summary?tier1_path=/infra/tier-1s/production_t1\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_policy_path\": \"/infra/realized-state/enforcement-points/default/logical-ports/pepsi-production_t1-t0_lrp\",\n \"last_update_timestamp\": 1705966281748,\n \"rx\": {\n \"total_bytes\": 205842,\n \"total_packets\": 4901,\n \"dropped_packets\": 401\n },\n \"tx\": {\n \"total_bytes\": 0,\n \"total_packets\": 0,\n \"dropped_packets\": 0\n },\n \"logical_router_port_id\": \"603a02fe-919b-53c4-a5bb-5cd905438108\"\n}\n"
}
},
"/infra/identity-firewall-stores/{identity-firewall-store-id}/ldap-servers/{ldap-server-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Get a specific LDAP server for a given Firewall Identity store",
"description": "Get a specific LDAP server for a given Firewall Identity store",
"operationId": "GetFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "identity-firewall-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityFirewallStoreLdapServer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/identity-firewall-stores/idstore-1/ldap-servers/b62cb721-345b-493e-a664-31b07a95b834\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"domain_name\": \"test.local\",\n \"host\": \"10.112.112.59\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"username\": \"Administrator\",\n \"resource_type\": \"IdentityFirewallStoreLdapServer\",\n \"id\": \"b62cb721-345b-493e-a664-31b07a95b834\",\n \"display_name\": \"Changed HERE AGAIN\",\n \"path\": \"/infra/firewall-identity-stores/thirdADWithPATCH/ldap-servers/b62cb721-345b-493e-a664-31b07a95b834\",\n \"relative_path\": \"b62cb721-345b-493e-a664-31b07a95b834\",\n \"parent_path\": \"/infra/firewall-identity-stores/thirdADWithPATCH\",\n \"unique_id\": \"4f4dc99c-e95d-4c82-9b81-b0d105e51c61\",\n \"realization_id\": \"4f4dc99c-e95d-4c82-9b81-b0d105e51c61\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_last_modified_time\": 1649156442612,\n \"_last_modified_user\": \"admin\",\n \"_create_time\": 1649152932330,\n \"_create_user\": \"admin\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Update a LDAP server for Firewall Identity store",
"description": "Update a LDAP server for Firewall Identity store",
"operationId": "ReplaceOrCreateFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "identity-firewall-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityFirewallStoreLdapServer"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityFirewallStoreLdapServer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/identity-firewall-stores/idstore-1/ldap-servers/b62cb721-345b-493e-a664-31b07a95b834\n{\n \"domain_name\": \"test.local\",\n \"host\": \"10.1.1.59\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"username\": \"Administrator\",\n \"password\": \"VMware!23\",\n \"resource_type\": \"IdentityFirewallStoreLdapServer\",\n \"id\": \"b62cb721-345b-493e-a664-31b07a95b834\",\n \"display_name\": \"Changed HERE AGAIN\",\n \"_create_time\": 1649149953654,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1649149953654,\n \"_last_modified_user\": \"admin\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"domain_name\": \"test.local\",\n \"host\": \"10.1.1.59\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"username\": \"Administrator\",\n \"resource_type\": \"IdentityFirewallStoreLdapServer\",\n \"id\": \"6fe12460-26f4-4569-a04c-1d5a21c92035\",\n \"display_name\": \"CHANGED LDAP\",\n \"path\": \"/infra/firewall-identity-stores/thirdADWithPATCH/ldap-servers/6fe12460-26f4-4569-a04c-1d5a21c92035\",\n \"relative_path\": \"6fe12460-26f4-4569-a04c-1d5a21c92035\",\n \"parent_path\": \"/infra/firewall-identity-stores/thirdADWithPATCH\",\n \"unique_id\": \"07b34161-3fa0-4479-961d-b825e1266196\",\n \"realization_id\": \"07b34161-3fa0-4479-961d-b825e1266196\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_time\": 1649152750819,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1649152750819,\n \"_last_modified_user\": \"admin\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "IdentityFirewallStoreLdapServer"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Delete a LDAP server for Firewall Identity store",
"description": "Delete a LDAP server for Firewall Identity store",
"operationId": "RemoveFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "identity-firewall-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/identity-firewall-stores/idstore-1/ldap-servers/01ad13c6-23c1-4175-ad3f-881eac8e45ef\n",
"x-vmw-nsx-module": "PolicyIdentity"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Create a LDAP server for Firewall Identity store",
"description": "More than one LDAP server can be created and only one LDAP\nserver is used to synchronize directory objects. If more\nthan one LDAP server is configured, NSX will try all the\nservers until it is able to successfully connect to one.\n",
"operationId": "PatchOrCreateFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "identity-firewall-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityFirewallStoreLdapServer"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityFirewallStoreLdapServer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/identity-firewall-stores/idstore-1/ldap-servers/6fe12460-26f4-4569-a04c-1d5a21c92035\n{\n \"domain_name\": \"test.local\",\n \"host\": \"10.1.1.59\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"username\": \"Administrator\",\n \"password\": \"VMware!23\",\n \"resource_type\": \"IdentityFirewallStoreLdapServer\",\n \"id\": \"6fe12460-26f4-4569-a04c-1d5a21c92035\",\n \"display_name\": \"CHANGED LDAP\",\n \"_create_time\": 1649152521744,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1649152521744,\n \"_last_modified_user\": \"admin\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"domain_name\": \"test.local\",\n \"host\": \"10.1.1.59\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"username\": \"Administrator\",\n \"resource_type\": \"IdentityFirewallStoreLdapServer\",\n \"id\": \"6fe12460-26f4-4569-a04c-1d5a21c92035\",\n \"display_name\": \"CHANGED LDAP\",\n \"path\": \"/infra/firewall-identity-stores/thirdADWithPATCH/ldap-servers/6fe12460-26f4-4569-a04c-1d5a21c92035\",\n \"relative_path\": \"6fe12460-26f4-4569-a04c-1d5a21c92035\",\n \"parent_path\": \"/infra/firewall-identity-stores/thirdADWithPATCH\",\n \"unique_id\": \"07b34161-3fa0-4479-961d-b825e1266196\",\n \"realization_id\": \"07b34161-3fa0-4479-961d-b825e1266196\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_time\": 1649152750819,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1649152750819,\n \"_last_modified_user\": \"admin\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "IdentityFirewallStoreLdapServer"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Get Port QoS Profile Binding Map",
"description": "API will get Port QoS Profile Binding Map.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Update Port QoS Profile Binding Map",
"description": "API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdatePortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n{\n \"resource_type\":\" PortQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"description\":\"\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortQoSProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Delete Port QoS Profile Binding Profile",
"description": "API will delete Port QoS Profile Binding Profile.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeletePortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Create Port QoS Profile Binding Map",
"description": "API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchPortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n{\n \"resource_type\":\" PortQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-codegen-request-body-name": "PortQoSProfileBindingMap"
}
},
"/global-infra/settings/firewall/export?action=cancel": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Task"
],
"summary": "Cancel a running export task",
"description": "This operation cancels an export task. Task needs to be in running state.\n",
"operationId": "GlobalInfraCancelExportTask",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export?action=cancel\n",
"x-vmw-nsx-module": "PolicyTask",
"x-vmw-nsx-example-response": "{\n \"id\": \"export_task\",\n \"status\": \"canceled\",\n \"description\": \"Export of the current firewall configuration.\",\n \"exported_file\": null,\n \"failure_msg\": null,\n \"user\": \"admin\",\n \"start_time\": 1587491995996\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}/aggregated": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Get an aggregated configuration for the draft",
"description": "Get an aggregated configuration that will get applied onto current\nconfiguration during publish of this draft.\nThe response is a hierarchical payload containing the aggregated\nconfiguration differences from the latest auto draft till the specified draft.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetAggregatedConfigurationToBePublishedForDraft",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Infra"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft/aggregated\n",
"x-vmw-nsx-module": "PolicyDraft",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Infra\",\n \"id\": \"infra\",\n \"display_name\": \"infra\",\n \"path\": \"/infra\",\n \"children\": [\n {\n \"children\": [\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-1\",\n \"display_name\": \"app-section-1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 1,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"target_type\": \"Domain\",\n \"resource_type\": \"ChildResourceReference\",\n \"id\": \"default\",\n \"marked_for_delete\": false,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/kubernetes-services": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get kubernetes services that belong to this Group",
"description": "Get kubernetes services that belong to this Group. This API is applicable for Groups\ncontaining KubernetesService member type. For\nGroups containing other member types an empty list is returned\n",
"operationId": "GetGroupKubernetesServiceMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster_id",
"in": "query",
"description": "Cluster ID",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupKubernetesServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/kubernetes-services?cluster_id=6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"clusters\": [\n {\n \"external_id\": \"6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"ANTK01\",\n \"namespaces\": [\n {\n \"external_id\": \"e0b2ec27-852d-4cc3-9818-b5869e7589e6\",\n \"display_name\": \"kube-node-lease\",\n \"kubernetes_services\": [\n {\n \"external_id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"frontend\",\n \"type\": \"LoadBalancer\",\n \"load_balance_ingress_ip_addresses\": [\n \"100.71.35.11\",\n \"\"\n ],\n \"node_port_local_endpoints\": [ ],\n \"cluster_ips\": [ ]\n },\n {\n \"external_id\": \"34b5793c-af87-41c4-80fa-f87fff77ef53\",\n \"display_name\": \"kubernetes\",\n \"type\": \"ClusterIP\",\n \"load_balance_ingress_ip_addresses\": [ ],\n \"node_port_local_endpoints\": [\n {\n \"node_ip\": \"100.71.35.11\",\n \"node_port\": \"30007\"\n }\n ],\n \"cluster_ips\": [\n \"100.64.147.218\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n],\n\"result_count\": 2,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/infra/segments/{segment-id}/dhcp-static-binding-configs": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings"
],
"summary": "List all DHCP static bindings",
"description": "Paginated list of all DHCP static binding instances\n",
"operationId": "ListInfraSegmentDhcpStaticBinding",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web1/dhcp-static-binding-configs\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"vm1-address\",\n \"path\": \"/infra/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595977854,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"Status"
],
"summary": "Get segment port status information",
"description": "Get tier1 segment port status information.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetSegmentPortStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1//infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:cf3a0716-3ba0-4327-a8e5-b1e76269108f/status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_port_id\": \"04efc498-b872-40fc-83f8-ebf9317a2766\",\n \"last_update_timestamp\": 1453764613211,\n \"status\": \"UP\"\n}\n"
}
},
"/infra/tier-1s/{tier1-id}/locale-services/{locale-services-id}/session-timer-profile-bindings/{session-timer-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices.\n",
"operationId": "GetTier1LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will create or update Session Timer profile binding map for Tier-1 Logical Router LocaleServices.",
"operationId": "UpdateTier1LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n {\n \"resource_type\":\"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices",
"description": "API will delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices.",
"operationId": "DeleteTier1LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will create or update Session Timer profile binding map for Tier-1 Logical Router LocaleServices.",
"operationId": "PatchTier1LocaleServicesSessionTimerProfileBindingMap",
"parameters": [
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n {\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
}
},
"/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Read rule",
"description": "Read rule",
"operationId": "GlobalInfraReadSecurityRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/firewall/rules": {
"get": {
"tags": [
"Policy",
"Security"
],
"summary": "Get rules filtered based on the given criteria",
"description": "Get the list of rules of given parent path of policy/section, filtered\nbased on the given criteria.\nParent path is mandatory.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetFilteredRules",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "parent_path",
"in": "query",
"description": "Path of the parent object of the entities",
"schema": {
"type": "string"
}
},
{
"name": "scope",
"in": "query",
"description": "Scope filter criteria",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/firewall/rules?parent_path=/infra/domains/default/security-policies/sp1&scope=6f1c310b-aeed-445e-aef9-9722c8967ab8&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1/rules/rule1\",\n \"target_id\" : \"rule1\",\n \"target_type\" : \"RULE\",\n \"is_valid\" : \"true\"\n },\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1/rules/rule2\",\n \"target_id\" : \"rule2\",\n \"target_type\" : \"RULE\",\n \"is_valid\" : \"true\"\n }\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-group-associations": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Security",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given IP address is a member",
"description": "Get policy groups for which the given IP address is a member.\n",
"operationId": "GetVpcGroupsForIPAddress",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "ip_address",
"in": "query",
"description": "IPAddress",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-2/ip-address-group-associations?ip_address=10.112.4.3\n",
"x-vmw-nsx-module": "PolicyVpcGroup",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"target_id\": \"/orgs/default/projects/project-1/vpcs/vpc-2/groups/default\",\n \"target_display_name\": \"ORG-default-PROJECT-project-1-VPC-vpc-2-default\",\n \"target_type\": \"VPC_GROUP\",\n \"is_valid\": true,\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-2/groups/default\"\n },\n {\n \"target_id\": \"/orgs/default/projects/project-1/vpcs/vpc-2/groups/subnet-group-1\",\n \"target_display_name\": \"subnet-group\",\n \"target_type\": \"VPC_GROUP\",\n \"is_valid\": true,\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-2/groups/subnet-group-1\"\n }\n ],\n \"result_count\": 3,\n \"sort_by\": \"target_display_name\",\n \"sort_ascending\": true,\n \"cursor\": \"00012\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/mac-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"MAC Table"
],
"summary": "Get MAC table for infra segment port",
"description": "Returns MAC table for a segment port\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentPortMacTable",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortMacAddressListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWN_LINK_SWITCH/ports/default:d808cd01-b20b-485b-8e57-983a84fa7642/mac-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"transport_node_id\": \"01b3242e-a7c8-11ea-9a01-278a0b44b8c9\",\n \"last_update_timestamp\": 1591767152521,\n \"results\": [\n {\n \"mac_address\": \"00:0c:29:ce:0f:77\",\n \"mac_type\": \"STATIC\"\n }\n ]\n}\n"
}
},
"/infra/settings/firewall/import?action=cancel": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Task"
],
"summary": "Cancel a running import task",
"description": "This operation cancels an import task. Task needs to be in running state.\n",
"operationId": "CancelImportTask",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/import?action=cancel\n",
"x-vmw-nsx-module": "PolicyTask",
"x-vmw-nsx-example-response": "{\n \"id\": \"import_task\",\n \"status\": \"canceled\",\n \"description\": \"Import of fw_config_apr2020.zip\",\n \"draft_path\": \"/infra/drafts/imported_fw_config_apr2020\"\n \"failure_msg\": null,\n \"user\": \"admin\",\n \"start_time\": 1587491995996\n}\n"
}
},
"/alb/controller-nodes/system-configuration": {
"put": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Alb System Config"
],
"summary": "Update DNS, NTP and Backup server config in ALB controller.",
"description": "Use this API to update DNS, NTP and Backup server config in ALB controller.\nThis API is for VCF deployments only.\n",
"operationId": "UpdateAlbSystemConfiguration",
"parameters": [
{
"name": "running_config",
"in": "query",
"description": "Update Advanced Load Balancer Controller runtime config as well",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerSystemConfiguration"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerSystemConfigurationResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/alb/controller-nodes/system-configuration\n{\n \"dns_servers\": [\n \"10.33.38.2\"\n ],\n \"ntp_servers\": [\n \"10.166.1.110\"\n ],\n \"backup_server_config\": {\n \"server_address\": \"10.20.30.4\",\n \"username\": \"backupUser\",\n \"password\": \"password1\",\n \"backup_location\": \"/vmware/backup\",\n \"backup_passphrase\": \"password1\"\n },\n \"clustering_id\": \"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n}\n",
"x-vmw-nsx-module": "PolicyALBControllerOnBoarding",
"x-vmw-nsx-example-response": "{status: \"NSX Advanced Load Balancer Controller system configuration updated successfully.\"}\n",
"x-codegen-request-body-name": "ALBControllerSystemConfiguration"
}
},
"/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Status"
],
"summary": "Get L2VPN session detailed status under Tier-1",
"description": "- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.\n- an enforcement point path is specified: detailed status is evaluated only on the given\nenforcement point.\n- source=realtime: detailed tatus is fetched realtime from the enforcement point.\n- source=cached: cached detailed status is returned.\n",
"operationId": "GetTier1VpnL2VpnSessionStatus",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VPNSessionStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/l2vpn-services/default/sessions/stretched-pa-site/detailed-status\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/domains/{domain-id}/communication-maps/{communication-map-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Communication Maps"
],
"summary": "Revise the positioning of communication maps",
"description": "This is used to set a precedence of a communication map w.r.t others.\n\n
\nThis API is deprecated. Please use the following API instead.\nPOST /infra/domains/domain-id/security-policies/security-policy-id?action=revise\n",
"operationId": "ReviseCommunicationMaps",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "communication-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The communication map/communication entry path if operation is\n'insert_after' or 'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommunicationMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommunicationMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/vmc/communication-maps/application-section-1?action=revise&anchor_path=/infra/domains/vmc/communication-maps/emergency-section&operation=insert_before\n{\n \"description\": \"comm map revised\",\n \"display_name\": \"application-section-1\",\n \"category\":\"Application\",\n \"communication_entries\": [\n {\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"action\": \"ALLOW\"\n }\n\n ]\n}\n",
"x-vmw-nsx-module": "PolicyDfw",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"CommunicationMap\",\n \"description\": \"comm map\",\n \"id\": \"application-section-1\",\n \"display_name\": \"application-section-1\",\n \"path\": \"/infra/domains/vmc/communication-maps/application-section-1\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"application-section-1\",\n \"communication_entries\": [\n {\n \"resource_type\": \"CommunicationEntry\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/communication-maps/application-section-1/communication-entries/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/communication-maps/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ],\n \"category\": \"Application\",\n \"precedence\": 0,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317362027,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "CommunicationMap"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/forwarding": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Multicast"
],
"summary": "Get Multicast Forwarding",
"description": "Get Multicast Forwarding.\n",
"operationId": "GetPolicyMulticastForwarding",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyMulticastForwarding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-0s/tier0/locale-services/tier0localeservices/multicast/forwarding\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"gateway_path\": \"/infra/tier-0s/tier0\",\n \"mcast_forwarding_per_edge\": [\n {\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a9b95292-51f7-11ea-ae0d-005056a3c9f4\",\n \"mcast_forwarding\": []\n },\n {\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a96e2790-51f7-11ea-aedf-005056a370d4\",\n \"mcast_forwarding\": [\n {\n \"source\": \"1.1.5.10\",\n \"multicast_group\": \"239.102.102.102\",\n \"incoming_interface\": {\n \"ifuid\": \"e60c61b4-acf9-4db6-91b8-1ed1bb8732bd\"\n },\n \"outgoing_interfaces\": [\n {\n \"ifuid\": \"/infra/tier-0s/tier0/locale-services/tier0localeservices/interfaces/tier0-interface-40-40-40-1\"\n }\n ]\n }\n ]\n }\n ]\n}\n"
}
},
"/global-infra/domains/{domain-id}/groups/{group-id}/firewall-session-timer-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Bindings"
],
"summary": "List Firewall Session Timer Profile Binding Maps",
"description": "API will list all Firewall Session Timer Profile Binding Maps in current group id.\n",
"operationId": "GlobalInfraListPolicyFirewallSessionTimerBindings",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallSessionTimerProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-session-timer-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyFirewallSessionTimerProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PolicyFirewallSessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"binding-map-1\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-session-timer-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallSessionTimerProfileBindingMaps\",\n \"firewall_session_timer_profile_path\":\"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Statistics"
],
"summary": "Get L2VPN session statistics under Tier-1",
"description": "- no enforcement point path specified: statistics are evaluated on each enforcement point.\n- an enforcement point path is specified: statistics are evaluated only on the given\nenforcement point.\n- source=realtime: statistics are fetched realtime from the enforcement point.\n- source=cached: cached statistics from the enforcement point are returned.\n",
"operationId": "GetTier1VpnL2VpnSessionStatistics",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VPNSessionStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/l2vpn-services/default/sessions/stretched-pa-site/statistics\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/segments/{segment-id}/arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from segment interface (downlink) in CSV format",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the\ninterface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge\nnode specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "GetInfraSegmentInterfaceArpTableCsv",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web-app-seg/arp-table?format=csv&enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,ip\n02:50:56:56:44:52,172.16.20.1\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-node-collections/{transport-node-collections-id}": {
"put": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Node Collections"
],
"summary": "Create transport node collection by attaching Transport Node Profile to cluster.",
"description": "When transport node collection is created the hosts which are part\nof compute collection will be prepared automatically i.e. NSX Manager\nattempts to install the NSX components on hosts. Transport nodes for these\nhosts are created using the configuration specified in transport node\nprofile. Pass apply_profile to false, if you do not want to apply\ntransport node profile on the existing transport node with\noverridden host flag set and ignore overridden hosts flag is set to\ntrue on the transport node profile.\n",
"operationId": "CreateOrUpdateHostTransportNodeCollection",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transport-node-collections-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apply_profile",
"in": "query",
"description": "Indicates if the Transport Node Profile (TNP) configuration should be applied during creation",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "override_nsx_ownership",
"in": "query",
"description": "Override NSX Ownership",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostTransportNodeCollection"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HostTransportNodeCollection"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/TNCId1\n{\n\"resource_type\": \"HostTransportNodeCollection\",\n\"display_name\": \"TNC1\",\n\"description\": \"Transport Node Collections 1\",\n\"compute_collection_id\": \"33dbf426-c282-42a0-9ae2-5e924b8a78b4:domain-c38\",\n\"transport_node_profile_id\": \"/infra/host-transport-node-profiles/tnp1\"\n}\nPUT https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/TNCId1?apply_profile=false\n{\n\"resource_type\": \"HostTransportNodeCollection\",\n\"display_name\": \"TNC1\",\n\"description\": \"Transport Node Collections 1\",\n\"compute_collection_id\": \"33dbf426-c282-42a0-9ae2-5e924b8a78b4:domain-c38\"\n\"transport_node_profile_id\": \"/infra/host-transport-node-profiles/tnp1\",\n}\n",
"x-vmw-nsx-module": "HostTransportNodeCollection",
"x-vmw-nsx-example-response": "{\n\"resource_type\": \"HostTransportNodeCollection\",\n\"display_name\": \"TNC1\",\n\"description\": \"Transport Node Collections 1\",\n\"id\": \"TNCId1\",\n\"compute_collection_id\": \"33dbf426-c282-42a0-9ae2-5e924b8a78b4:domain-c38\"\n\"transport_node_profile_id\": \"/infra/host-transport-node-profiles/tnp1\",\n\"path\": \"/infra/sites/default/enforcement-points/default/transport-node-collections/TNCId1\",\n\"relative_path\": \"TNCId1\",\n\"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n\"unique_id\": \"46ea1ae3-b067-4985-bd9e-6e1d4b1b2ec1\",\n\"marked_for_delete\": false,\n\"overridden\": false,\n\"_create_user\": \"admin\",\n\"_create_time\": 1604165575433,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1604165575433,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 0\n}\n",
"x-codegen-request-body-name": "HostTransportNodeCollection"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "List Port QoS Profile Binding Maps",
"description": "API will list all Port QoS Profile Binding Maps in current port id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListPortQoSBindings",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"PortQoSProfileBindingMaps\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/crls": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certification Revocation List"
],
"summary": "Return All Added CRLs",
"description": "Returns information about all CRLs. For additional information, include the\n?details=true modifier at the end of the request URI.\n",
"operationId": "ListTlsCrls",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "whether to expand the pem data and show all its details",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "node_id",
"in": "query",
"description": "Node ID of certificate to return",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type of certificate to return",
"schema": {
"type": "string",
"enum": [
"cluster_api_certificate",
"api_certificate"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCrlListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/crls?details=true\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"TlsCrl\",\n \"display_name\": \"revoked certificates\",\n \"path\": \"/infra/crls/revokedCerts\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"revokedCerts\",\n \"pem_encoded\": \"-----BEGIN X509 CRL----------END X509 CRL-----\\n\",\n \"details\": {\n \"next_update\": \"945220365000\",\n \"issuer\": \"1.2.840.113549.1.9.1=#161d726f6f744069676c6f6f2e6974732e756e696d656c622e6564752e6175,CN=igloo Certificate Authority,OU=Certificates Administration,O=igloo CA,L=Melbourne,ST=Victoria,C=AU\",\n \"version\": \"1\"\n },\n \"crl_type\": \"X509\",\n \"unique_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"realization_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1413387436438,\n \"_create_time\": 1413386249116,\n \"_create_user\": \"admin\"\n },\n {\n \"crl_type\": \"OneCRL\",\n \"one_crl\": \"{\\\"data\\\":[ <...> ]}\",\n \"details_revoked_by_issuer_and_serial_number\": [ <...> ],\n \"details_revoked_by_subject_and_public_key_hash\": [ <...> ],\n \"resource_type\": \"TlsCrl\",\n \"id\": \"default_public_crl\",\n \"display_name\": \"default_public_crl\",\n \"path\": \"/infra/crls/default_public_crl\",\n \"relative_path\": \"default_public_crl\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"91503436-5215-4d13-93e0-094c7473e30d\",\n \"realization_id\": \"91503436-5215-4d13-93e0-094c7473e30d\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1630097138768,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1630107914252,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n ]\n}\n"
}
},
"/licenses/vcf-licenses": {
"post": {
"tags": [
"System Administration",
"Settings",
"Licenses"
],
"summary": "Synchronize VCF licenses from all registered vCenters\n",
"description": "Synchronize VCF licenses from all registered vCenters and update\nlicenses in NSX. This API will not return synchronized VCF licenses\nand just update them in NSX.\n",
"operationId": "DeprecatedSyncVCFLicenses",
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/licenses/vcf-licenses\n",
"x-vmw-nsx-module": "VCSync"
}
},
"/infra/span": {
"get": {
"tags": [
"Federation",
"Sites"
],
"summary": "Get span for an entity with specified path",
"description": "Get span for an entity with specified path.",
"operationId": "GetSpan",
"parameters": [
{
"name": "intent_path",
"in": "query",
"description": "String Path of the intent object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "site_path",
"in": "query",
"description": "Policy Path of the site",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Span"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<global-manager>/global-manager/api/v1/global-infra/span?intent_path=/global-infra/tier-0s/t0\n",
"x-vmw-nsx-module": "PolicySitesSpan",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SPAN\",\n \"span_resource_type\": \"PROVIDER\",\n \"span_resource\": \"/global-infra/tier-0s/t0\",\n \"span_leader\": \"/global-infra/tier-0s/t0\",\n \"site_ids\": [\n \"51a1294a-b1d5-40a9-a382-2b1aeb62c41a\",\n \"3d497d3f-2f9a-4983-9db0-d1f5f7cbc3d0\"\n ],\n \"marked_for_delete\": false,\n \"overridden\": false\n}\n"
}
},
"/infra/ipsec-vpn-ike-profiles/{ike-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IKE Profiles"
],
"summary": "Get IKE Profile",
"description": "Get custom IKE Profile, given the particular id.",
"operationId": "GetIPSecVpnIkeProfile",
"parameters": [
{
"name": "ike-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnIkeProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-ike-profiles/aws-ike-profile",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnIkeProfile\",\n \"display_name\" : \"aws-ike-profile\",\n \"path\": \"/infra/ipsec-vpn-ike-profiles/aws-ike-profile\",\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"ike_version\" : \"IKE_V1\",\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 86400,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IKE Profiles"
],
"summary": "Create or fully replace a custom internet key exchange (IKE) Profile",
"description": "Create or fully replace custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.",
"operationId": "CreateOrUpdateIPSecVpnIkeProfile",
"parameters": [
{
"name": "ike-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnIkeProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnIkeProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-ike-profiles/aws-ike-profile\n{\n \"resource_type\" : \"IPSecVpnIkeProfile\",\n \"display_name\" : \"aws-ike-profile\",\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"ike_version\" : \"IKE_V1\",\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 86400,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"_revision\" : 2,\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnIkeProfile\",\n \"display_name\" : \"aws-ike-profile\",\n \"path\": \"/infra/ipsec-vpn-ike-profiles/aws-ike-profile\",\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"ike_version\" : \"IKE_V1\",\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 86400,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnIkeProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IKE Profiles"
],
"summary": "Delete custom IKE Profile",
"description": "Delete custom IKE Profile. Profile can not be deleted if profile has references to it.",
"operationId": "DeleteIPSecVpnIkeProfile",
"parameters": [
{
"name": "ike-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-ike-profiles/aws-ike-profile\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IKE Profiles"
],
"summary": "Create or patch a custom internet key exchange (IKE) Profile",
"description": "Create or patch custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile.",
"operationId": "CreateOrPatchIPSecVpnIkeProfile",
"parameters": [
{
"name": "ike-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnIkeProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-ike-profiles/aws-ike-profile\n{\n \"resource_type\" : \"IPSecVpnIkeProfile\",\n \"display_name\" : \"aws-ike-profile\",\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"ike_version\" : \"IKE_FLEX\",\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 86400,\n \"dh_groups\" : [ \"GROUP14\" ]\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnIkeProfile"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures-diff": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Get IDS Custom Signature difference",
"description": "Get published and unpublished custom signatures difference.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIdsCustomSignaturesDiff",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsCustomSignaturesDiff"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1/custom-signatures-diff\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-vmw-nsx-example-response": "{\n \"newly_added_signatures\": [\n \"1000022211\"\n ],\n \"deleted_signatures\": [\n \"1000022222\"\n ],\n \"existing_signatures\": [\n \"1000033333\",\n \"1000011111\"\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Get Mac Discovery Profile",
"description": "API will get Mac Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetMacDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n",
"x-vmw-nsx-module": "PolicyMacDiscovery",
"x-vmw-nsx-example-response": "{\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/mac-discovery-profiles/mdp1\",\n \"relative_path\": \"mdp1\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Update Mac Discovery Profile",
"description": "API will update Mac Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateMacDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n {\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1,\n \"_revision\": 1\n }\n",
"x-vmw-nsx-module": "PolicyMacDiscovery",
"x-vmw-nsx-example-response": "{\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/mac-discovery-profiles/mdp1\",\n \"relative_path\": \"mdp1\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "MacDiscoveryProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Delete Mac Discovery Profile",
"description": "API will delete Mac Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteMacDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n",
"x-vmw-nsx-module": "PolicyMacDiscovery"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Create Mac Discovery Profile",
"description": "API will create Mac Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateMacDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n {\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1\n }\n",
"x-vmw-nsx-module": "PolicyMacDiscovery",
"x-codegen-request-body-name": "MacDiscoveryProfile"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"BGP"
],
"summary": "Get routes learned by BGP neighbor",
"description": "Returns routes learned by BGP neighbor from all edge nodes on which\nthis neighbor is currently enabled.\n",
"operationId": "GlobalInfraGetTier0BgpNeighborRoutes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "neighbor-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "Number of routes to retrieve",
"schema": {
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BgpNeighborRoutesListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/defalt/bgp/neighbors/to-onprem/routes\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"neighbor_path\": \"/infra/tier-0s/vmc/locale-services/defalt/bgp/neighbors/to-onprem\",\n \"enforcement_point_path\": \"/infra/deployment-zones/default/enforcement-points/default\",\n \"edge_node_routes\": [{\n \"transport_node_id\": \"6c9e2815-ad34-4b9c-bb95-8af87990cf5a\",\n \"source_address\": \"10.10.10.1\",\n \"routes\": [{\n \"network\": \"2.1.4.0/24\",\n \"next_hop\": \"40.40.40.10\",\n \"local_pref\": 0,\n \"weight\": 0,\n \"med\": 1,\n \"as_path\": 1000,\n \"route_origin\": \"INTERNAL\"\n },\n {\n \"network\": \"40.40.40.0/24\",\n \"next_hop\": \"40.40.40.10\",\n \"local_pref\": 0,\n \"weight\": 0,\n \"med\": 1,\n \"as_path\": 1000,\n \"route_origin\": \"INTERNAL\"\n }]\n },\n {\n \"transport_node_id\": \"7980e91e-ba6d-11e8-9bda-020009ead346\",\n \"source_address\": \"50.50.50.1\",\n \"routes\": [{\n \"network\": \"2.1.4.0/24\",\n \"next_hop\": \"40.40.40.10\",\n \"local_pref\": 0,\n \"weight\": 0,\n \"med\": 1,\n \"as_path\": 1000,\n \"route_origin\": \"INTERNAL\"\n },\n {\n \"network\": \"40.40.40.0/24\",\n \"next_hop\": \"40.40.40.10\",\n \"local_pref\": 0,\n \"weight\": 0,\n \"med\": 1,\n \"as_path\": 1000,\n \"route_origin\": \"INTERNAL\"\n }]\n }]\n}\n"
}
},
"/global-infra/domains/{domain-id}/groups/{group-id}/members/segments": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get segments that belong to this Group",
"description": "Get segments that belong to this Group\n",
"operationId": "GlobalInfraGetGroupSegmentMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/segments?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"id\": \"segment-1\",\n \"display_name\": \"segment-1\",\n \"path\": \"/infra/segments/segment-1\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/{cpu-mem-thresholds-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Get Firewall CPU Memory Thresholds Profile Binding Map",
"description": "API will get Firewall CPU Memory Thresholds Profile Binding Map.\n",
"operationId": "GetPolicyFirewallCPUMemThresholdsProfileBindingMap",
"parameters": [
{
"name": "cpu-mem-thresholds-profile-binding-map-id",
"in": "path",
"description": "Firewall CPU Memory Thresholds Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCPUMemThresholdsProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyFirewallCPUMemThresholdsProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMap\",\n \"id\" : \"1\",\n \"display_name\" : \"binding-map-1\",\n \"path\" : \"/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/1\",\n \"relative_path\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMaps\",\n \"profile_path\" : \"/infra/firewall-cpu-mem-thresholds-profiles/1\",\n \"transport_nodes\" : [{\n \"target_id\": \"f4af8b57-8957-3c00-8ce9-105b25609bd6\",\n \"target_type\": \"TransportNode\"\n }]\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Update Firewall CPU Memory Thresholds Profile Binding Map",
"description": "API will update Firewall CPU Memory Thresholds Profile Binding Map.",
"operationId": "UpdatePolicyFirewallCPUMemThresholdsProfileBindingMap",
"parameters": [
{
"name": "cpu-mem-thresholds-profile-binding-map-id",
"in": "path",
"description": "Firewall CPU Memory Thresholds Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCPUMemThresholdsProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCPUMemThresholdsProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/1\n{\n \"resource_type\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMap\",\n \"display_name\" : \"binding-map-1\",\n \"profile_path\" : \"/infra/firewall-cpu-mem-thresholds-profiles/1\",\n \"transport_nodes\" : [{\n \"target_id\": \"f4af8b57-8957-3c00-8ce9-105b25609bd6\",\n \"target_type\": \"TransportNode\"\n }]\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyFirewallCPUMemThresholdsProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMap\",\n \"id\" : \"1\",\n \"display_name\" : \"binding-map-1\",\n \"path\" : \"/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/1\",\n \"relative_path\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMaps\",\n \"profile_path\" : \"/infra/firewall-cpu-mem-thresholds-profiles/1\",\n \"transport_nodes\" : [{\n \"target_id\": \"f4af8b57-8957-3c00-8ce9-105b25609bd6\",\n \"target_type\": \"TransportNode\"\n }]\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PolicyFirewallCPUMemThresholdsProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Delete Firewall CPU Memory Thresholds Profile Binding",
"description": "API will delete Firewall CPU Memory Thresholds Profile Binding.",
"operationId": "DeletePolicyFirewallCPUMemThresholdsProfileBindingMap",
"parameters": [
{
"name": "cpu-mem-thresholds-profile-binding-map-id",
"in": "path",
"description": "Firewall CPU Memory Thresholds Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyFirewallCPUMemThresholdsProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Create or update Firewall CPU Memory Thresholds Profile Binding Map",
"description": "API will create or update Firewall CPU Memory Thresholds Profile binding map.",
"operationId": "PatchPolicyFirewallCPUMemThresholdsProfileBindingMap",
"parameters": [
{
"name": "cpu-mem-thresholds-profile-binding-map-id",
"in": "path",
"description": "Firewall CPU Memory Thresholds Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCPUMemThresholdsProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/1\n {\n \"resource_type\" : \"PolicyFirewallCPUMemThresholdsProfileBindingMap\",\n \"display_name\" : \"binding-map-1\",\n \"profile_path\" : \"/infra/firewall-cpu-mem-thresholds-profiles/1\",\n \"transport_nodes\" : [{\n \"target_id\": \"f4af8b57-8957-3c00-8ce9-105b25609bd6\",\n \"target_type\": \"TransportNode\"\n }]\n }\n",
"x-vmw-nsx-module": "PolicyFirewallCPUMemThresholdsProfileBinding",
"x-codegen-request-body-name": "PolicyFirewallCPUMemThresholdsProfileBindingMap"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Revise the positioning of gateway rule",
"description": "This is used to re-order a gateway rule within a gateway policy.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReviseGatewayRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/vmc/gateway-policies/cgw-1/rules/ce-1?action=revise&anchor_path=/infra/domains/vmc/gateway-policies/cgw-1/rules/ce-2&operation=insert_after\n{\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc_domain/gateway-policies/cgw-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc_domain/gateway-policies/cgw-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc_domain/groups/webgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc_domain/groups/appgroup\"\n ],\n \"scope\": [\n \"/infra/tier-1s/cgw\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/AD_Server\",\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/gateway-policies/cgw-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/gateway-policies/cgw-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"/infra/tier-1s/cgw\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "Rule"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from tier-0 interface in CSV format",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format\nfor the tier-0 interface, on a edge node if a query parameter\n\"edge_path=<policy-edge-path>\" is given. The edge_path\nparameter is mandatory if the interface type is not EXTERNAL.\n",
"operationId": "GlobalInfraGetTier0InterfaceArpTableCsv",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/t0/locale-services/default/interfaces/to_internet/arp-table?format=csv&enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,ip\n02:50:56:56:44:52,172.16.20.1\n"
}
},
"/alb/controller-nodes/clusterconfig": {
"get": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Cluster Config"
],
"summary": "Returns info for of the cluster configuration for the Advanced Load Balancer controller cluster",
"description": "Returns cluster configuration for the Advanced Load Balancer controller cluster.\n",
"operationId": "ReadALBControllerNodeClusterConfig",
"parameters": [
{
"name": "clustering_id",
"in": "query",
"description": "Unique Id for NSX Advanced Load Balancer Controller Cluster used in VCF managed NSX.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerNodeVMClusterConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/alb/controller-nodes/clusterconfig?clustering_id=\"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n",
"x-vmw-nsx-module": "PolicyALBControllerDeployment",
"x-vmw-nsx-example-response": "{\n \"cluster_ip\":\"10.79.169.57\",\n \"cluster_name\": \"alb_controller_cluster\",\n \"cluster_uuid\" : \"236d4061-5eb6-4b56-a87e-e9dc9eb2a291\"\n}\n"
},
"post": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Cluster Config"
],
"summary": "Set the cluster configuration for the Advanced Load Balancer controller VM. The VIP can be set once. Attempting to change the VIP once set will return an error.",
"description": "Set the cluster configuration for Advanced Load Balancer controller cluster.\n",
"operationId": "AddALBControllerNodeClusterConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerNodeVMClusterConfig"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerNodeVMClusterConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/alb/controller-nodes/clusterconfig\n{\n \"cluster_ip\" :\"10.79.169.56\",\n \"cluster_name\": \"alb_controller_cluster\",\n \"clustering_id\": \"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n}\n",
"x-vmw-nsx-module": "PolicyALBControllerDeployment",
"x-vmw-nsx-example-response": "{\n \"cluster_ip\" :\"10.79.169.56\",\n \"cluster_name\": \"alb_controller_cluster\",\n \"cluster_uuid\" : \"236d4061-5eb6-4b56-a87e-e9dc9eb2a291\",\n \"clustering_id\": \"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n}\n",
"x-codegen-request-body-name": "ALBControllerNodeVMClusterConfig"
},
"delete": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Cluster Config"
],
"summary": "Delete the cluster configuration for the Advanced Load Balancer controller cluster configuration. If Advanced Load Balancer controllers are present delete will fail.",
"description": "Delete the cluster configuration for Advanced Load Balancer controller cluster.\nThis API is for VCF deployments only.\n",
"operationId": "DeleteALBControllerNodeClusterConfig",
"parameters": [
{
"name": "clustering_id",
"in": "query",
"description": "Unique Id for NSX Advanced Load Balancer Controller Cluster used in VCF managed NSX.",
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/alb/controller-nodes/clusterconfig/?clustering_id=\"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n",
"x-vmw-nsx-module": "PolicyALBControllerDeployment"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Get Infra Port Discovery Profile Binding Map",
"description": "API will get Infra Port Discovery Profile Binding Map\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraPortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Infra Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Update Infra Port Discovery Profile Binding Map",
"description": "API will update Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateInfraPortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Infra Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n{\n \"resource_type\":\" PortDiscoveryProfileBindingMap\",\n \"display_name\": \"PortDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortDiscoveryProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Delete Infra Port Discovery Profile Binding Profile",
"description": "API will delete Infra Port Discovery Profile Binding Profile",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteInfraPortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Infra Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Create Infra Port Discovery Profile Binding Map",
"description": "API will create Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchInfraPortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n {\n \"resource_type\":\" PortDiscoveryProfileBindingMap\",\n \"display_name\": \"PortDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n }\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-codegen-request-body-name": "PortDiscoveryProfileBindingMap"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/member-types": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get member types for a given Group",
"description": "It retrieves member types for a given group. In case of nested groups, it calculates\nmember types of child groups as well. Considers member type for members added\nvia static members and dynamic membership criteria.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetMemberTypesForGroup",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupMemberTypeListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/groups/webgroup/member-types\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resultCount\": 1,\n \"results\" : [\"VirtualMachine\"]\n}\n"
}
},
"/infra/host-switch-profiles": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Profiles",
"Hostswitch Profiles"
],
"summary": "List Hostswitch Profiles",
"description": "Returns information about the configured hostswitch profiles. Hostswitch\nprofiles define networking policies for hostswitches (sometimes referred to\nas bridges in OVS). Currently, following profiles are supported.\nUplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile.\nUplink profile - teaming defined in this profile allows NSX to load balance traffic across\ndifferent physical NICs (PNICs) on the hypervisor hosts. Multiple teaming policies are\nsupported, including LACP active, LACP passive, load balancing based on source ID, and\nfailover order.\nLldp profile - Activate or deactivate sending LLDP packets\nNiocProfile - Network I/O Control settings: defines limits, shares and reservations for\nvarious host traffic types.\nExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port\n",
"operationId": "ListPolicyHostSwitchProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "deployment_type",
"in": "query",
"description": "Supported edge deployment type.",
"schema": {
"type": "string",
"enum": [
"VIRTUAL_MACHINE",
"PHYSICAL_MACHINE",
"UNKNOWN"
]
}
},
{
"name": "hostswitch_profile_type",
"in": "query",
"description": "Supported HostSwitch profiles.",
"schema": {
"type": "string",
"enum": [
"PolicyUplinkHostSwitchProfile",
"PolicyLldpHostSwitchProfile",
"PolicyNiocProfile",
"PolicyExtraConfigHostSwitchProfile",
"PolicyVtepHAHostSwitchProfile",
"PolicyHighPerformanceHostSwitchProfile"
]
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_system_owned",
"in": "query",
"description": "Whether the list result contains system resources",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "max_active_uplink_count",
"in": "query",
"description": "Filter uplink profiles by number of active links in teaming policy.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "node_type",
"in": "query",
"description": "Fabric node type for which uplink profiles are to be listed",
"schema": {
"type": "string",
"enum": [
"EdgeNode",
"PublicCloudGatewayNode"
]
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "uplink_teaming_policy_name",
"in": "query",
"description": "The host switch profile's uplink teaming policy name",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyHostSwitchProfilesListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/host-switch-profiles\n\nGET https://<policy-mgr>/policy/api/v1/infra/host-switch-profiles?\n hostswitch_profile_type=PolicyUplinkHostSwitchProfile&\n include_system_owned=true&\n node_type=EdgeNode&\n deployment_type=VIRTUAL_MACHINE&\n max_active_uplink_count=2\n",
"x-vmw-nsx-module": "PolicyBaseHostSwitchProfile",
"x-vmw-nsx-example-response": "{\n \"TODO\" : \"Add all 4 profile examples\"\n \"results\" : [\n {\n \"lags\": [\n {\n \"name\": \"lag1\",\n \"id\": \"7535\",\n \"mode\": \"ACTIVE\",\n \"load_balance_algorithm\": \"SRCMAC\",\n \"number_of_uplinks\": 2,\n \"uplinks\": [\n {\n \"uplink_name\": \"lag1-0\",\n \"uplink_type\": \"PNIC\"\n },\n {\n \"uplink_name\": \"lag1-1\",\n \"uplink_type\": \"PNIC\"\n }\n ],\n \"timeout_type\": \"FAST\"\n }\n ],\n \"teaming\": {\n \"policy\": \"LOADBALANCE_SRC_MAC\",\n \"active_list\": [\n {\n \"uplink_name\": \"lag1\",\n \"uplink_type\": \"LAG\"\n }\n ]\n },\n \"transport_vlan\": 19,\n \"overlay_encap\": \"GENEVE\",\n \"resource_type\": \"PolicyUplinkHostSwitchProfile\",\n \"id\": \"uplinkProfile1\",\n \"display_name\": \"Custom-uplinkProfile1\",\n \"path\": \"/infra/host-switch-profiles/uplinkProfile1\",\n \"relative_path\": \"uplinkProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"0a72be13-046f-4872-97a3-785841b9df28\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 1612465522414,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612465522414,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"send_enabled\": true,\n \"resource_type\": \"LldpHostSwitchProfile\",\n \"id\": \"lldpProfile1\",\n \"display_name\": \"Custom-lldpProfile1\",\n \"path\": \"/infra/host-switch-profiles/lldpProfile1\",\n \"relative_path\": \"lldpProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"b84d93ce-43e1-4930-8e74-bef8ad1c8f18\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 1612464678118,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612464678118,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"host_infra_traffic_res\": [\n {\n \"traffic_type\": {\n \"traffic_name\": \"FAULT_TOLERANCE\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"HBR\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"ISCSI\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"MANAGEMENT\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"NFS\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"VDP\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"VIRTUAL_MACHINE\"\n },\n \"limit\": -1.0,\n \"shares\": 100,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"VMOTION\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n },\n {\n \"traffic_type\": {\n \"traffic_name\": \"VSAN\"\n },\n \"limit\": -1.0,\n \"shares\": 50,\n \"reservation\": 0.0\n }\n ],\n \"enabled\": true,\n \"resource_type\": \"NiocProfile\",\n \"id\": \"niocProfile1\",\n \"display_name\": \"Custom-niocProfile1\",\n \"path\": \"/infra/host-switch-profiles/niocProfile1\",\n \"relative_path\": \"niocProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"32ea1c6a-96c8-466b-ac51-3486efdbf153\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 1612468369585,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612468369585,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"extra_configs\": [\n {\n \"config_pair\": {\n \"key\": \"sampleKey\",\n \"value\": \"sampleValue\"\n }\n }\n ],\n \"resource_type\": \"ExtraConfigHostSwitchProfile\",\n \"id\": \"extraConfigProfile1\",\n \"display_name\": \"Custom-extraConfigProfile1\",\n \"path\": \"/infra/host-switch-profiles/extraConfigProfile1\",\n \"relative_path\": \"extraConfigProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"609673e1-a33f-4aef-ad0d-48e39715df4b\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 1612410420180,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612410420180,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 4,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Get IPSec VPN service",
"description": "Get given IPSec VPN service under Tier-1.\n",
"operationId": "GetTier1VpnIPSecVpnService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnService\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default\",\n \"enabled\" : false,\n \"bypass_rules\" : [],\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Create or fully replace IPSec VPN service",
"description": "Create or fully replace IPSec VPN service under Tier-1.\nRevision is optional for creation and required for update.\n",
"operationId": "CreateOrUpdateTier1VpnIPSecVpnService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default\n{\n \"resource_type\" : \"IPSecVpnService\",\n \"enabled\" : true,\n \"_revision\" : 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnService\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default\",\n \"enabled\" : false,\n \"bypass_rules\" : [],\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnService"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Delete IPSec VPN service",
"description": "Delete given IPSec VPN service under Tier-1.",
"operationId": "DeleteTier1VpnIPSecVpnService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Create or patch IPSec VPN service",
"description": "Create or patch IPSec VPN service under Tier-1.\n",
"operationId": "CreateOrPatchTier1VpnIPSecVpnService",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default\n{\n \"resource_type\": \"IPSecVpnService\",\n \"enabled\": true\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnService"
}
},
"/infra/settings/firewall/security/intrusion-services/stats?action=reset": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules",
"Statistics"
],
"summary": "Reset IDS-IPS rule statistics",
"description": "Sets IDS-IPS rule statistics counter to zero.\n- no enforcement point path specified: Reset of stats will be executed for\n each enforcement point.\n- {enforcement_point_path}: Reset of stats will be executed only for the given\n enforcement point.\n",
"operationId": "ResetIdsRuleStats",
"parameters": [
{
"name": "category",
"in": "query",
"description": "Aggregation statistic category",
"schema": {
"type": "string",
"default": "IDPSDFW",
"enum": [
"IDPSDFW",
"IDPSEDGE"
]
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/stats?action=reset&category=IDPSDFW\n",
"x-vmw-nsx-module": "PolicyIDSStats",
"x-vmw-nsx-example-response": ""
}
},
"/infra/connectivity-global-config": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Global Gateway Configuration"
],
"summary": "Read the connectivity global configuration",
"description": "Read the connectivity global configuration\n",
"operationId": "ReadConnectivityGlobalConfig",
"parameters": [
{
"name": "apply_locally",
"in": "query",
"description": "Flag to check reaching NSX+ or LM resource",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/connectivity-global-config\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"mtu\": 1500,\n \"fips\": {\n \"lb_fips_enabled\": true,\n \"tls_fips_enabled\": false\n },\n \"l3_forwarding_mode\": \"IPV4_AND_IPV6\",\n \"uplink_mtu_threshold\": 9000,\n \"vdr_mac\": \"02:50:56:56:44:52\",\n \"vdr_mac_nested\": \"02:50:56:56:44:53\",\n \"allow_changing_vdr_mac_in_use\": false,\n \"arp_limit_per_gateway\": 50000,\n \"external_gateway_bfd\": {\n \"bfd_profile_path\": \"/infra/bfd-profiles/default-external-gw-bfd-profile\",\n \"enable\": true\n },\n \"lb_ecmp\": false,\n \"remote_tunnel_physical_mtu\": 1700,\n \"physical_uplink_mtu\": 1700,\n \"global_replication_mode_enabled\": false,\n \"resource_type\": \"GlobalConfig\",\n \"id\": \"global-config\",\n \"display_name\": \"default\",\n \"path\": \"/infra/global-config\",\n \"relative_path\": \"global-config\",\n \"parent_path\": \"/infra\",\n \"remote_path\": \"\",\n \"unique_id\": \"3dd156ac-bb8b-47c6-850e-3a19f5522bf8\",\n \"realization_id\": \"3dd156ac-bb8b-47c6-850e-3a19f5522bf8\",\n \"owner_id\": \"a3b8ea94-a2ba-4427-8f18-2e29159f6754\",\n \"origin_site_id\": \"a3b8ea94-a2ba-4427-8f18-2e29159f6754\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_time\": 1669130975078,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1669132569827,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Global Gateway Configuration"
],
"summary": "Update the connectivity global configuration",
"description": "Update the connectivity global configuration",
"operationId": "UpdateConnectivityGlobalConfig",
"parameters": [
{
"name": "apply_locally",
"in": "query",
"description": "Flag to check reaching NSX+ or LM resource",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/connectivity-global-config\n{\n \"mtu\": 1500,\n \"fips\": {\n \"lb_fips_enabled\": true,\n \"tls_fips_enabled\": false\n },\n \"l3_forwarding_mode\": \"IPV4_AND_IPV6\",\n \"uplink_mtu_threshold\": 9000,\n \"tep_group_config\": {\n \"enable_tep_grouping_on_edge\": true\n },\n \"global_replication_mode_enabled\": false\n}\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"mtu\": 1500,\n \"fips\": {\n \"lb_fips_enabled\": true,\n \"tls_fips_enabled\": false\n },\n \"l3_forwarding_mode\": \"IPV4_AND_IPV6\",\n \"uplink_mtu_threshold\": 9000,\n \"vdr_mac\": \"02:50:56:56:44:52\",\n \"vdr_mac_nested\": \"02:50:56:56:44:53\",\n \"allow_changing_vdr_mac_in_use\": false,\n \"arp_limit_per_gateway\": 50000,\n \"external_gateway_bfd\": {\n \"bfd_profile_path\": \"/infra/bfd-profiles/default-external-gw-bfd-profile\",\n \"enable\": true\n },\n \"lb_ecmp\": false,\n \"remote_tunnel_physical_mtu\": 1700,\n \"physical_uplink_mtu\": 1700,\n \"global_replication_mode_enabled\": false,\n \"tep_group_config\": {\n \"enable_tep_grouping_on_edge\": true\n },\n \"resource_type\": \"GlobalConfig\",\n \"id\": \"global-config\",\n \"display_name\": \"default\",\n \"path\": \"/infra/global-config\",\n \"relative_path\": \"global-config\",\n \"parent_path\": \"/infra\",\n \"remote_path\": \"\",\n \"unique_id\": \"3dd156ac-bb8b-47c6-850e-3a19f5522bf8\",\n \"realization_id\": \"3dd156ac-bb8b-47c6-850e-3a19f5522bf8\",\n \"owner_id\": \"a3b8ea94-a2ba-4427-8f18-2e29159f6754\",\n \"origin_site_id\": \"a3b8ea94-a2ba-4427-8f18-2e29159f6754\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_time\": 1669130975078,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1669132569827,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "GlobalConfig"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Global Gateway Configuration"
],
"summary": "Update the connectivity global configuration",
"description": "Update the connectivity global configuration",
"operationId": "PatchConnectivityGlobalConfig",
"parameters": [
{
"name": "apply_locally",
"in": "query",
"description": "Flag to check reaching NSX+ or LM resource",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/connectivity-global-config\n{\n \"mtu\": 1500,\n \"fips\": {\n \"lb_fips_enabled\": true,\n \"tls_fips_enabled\": false\n },\n \"l3_forwarding_mode\": \"IPV4_AND_IPV6\",\n \"uplink_mtu_threshold\": 9000,\n \"tep_group_config\": {\n \"enable_tep_grouping_on_edge\": true\n },\n \"global_replication_mode_enabled\": false\n}\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"mtu\": 1500,\n \"fips\": {\n \"lb_fips_enabled\": true,\n \"tls_fips_enabled\": false\n },\n \"l3_forwarding_mode\": \"IPV4_AND_IPV6\",\n \"uplink_mtu_threshold\": 9000,\n \"vdr_mac\": \"02:50:56:56:44:52\",\n \"vdr_mac_nested\": \"02:50:56:56:44:53\",\n \"allow_changing_vdr_mac_in_use\": false,\n \"arp_limit_per_gateway\": 50000,\n \"external_gateway_bfd\": {\n \"bfd_profile_path\": \"/infra/bfd-profiles/default-external-gw-bfd-profile\",\n \"enable\": true\n },\n \"lb_ecmp\": false,\n \"remote_tunnel_physical_mtu\": 1700,\n \"physical_uplink_mtu\": 1700,\n \"global_replication_mode_enabled\": false,\n \"tep_group_config\": {\n \"enable_tep_grouping_on_edge\": true\n },\n \"resource_type\": \"GlobalConfig\",\n \"id\": \"global-config\",\n \"display_name\": \"default\",\n \"path\": \"/infra/global-config\",\n \"relative_path\": \"global-config\",\n \"parent_path\": \"/infra\",\n \"remote_path\": \"\",\n \"unique_id\": \"3dd156ac-bb8b-47c6-850e-3a19f5522bf8\",\n \"realization_id\": \"3dd156ac-bb8b-47c6-850e-3a19f5522bf8\",\n \"owner_id\": \"a3b8ea94-a2ba-4427-8f18-2e29159f6754\",\n \"origin_site_id\": \"a3b8ea94-a2ba-4427-8f18-2e29159f6754\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_time\": 1669130975078,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1669132569827,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "GlobalConfig"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/shares/{share-id}": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"Shared Resource"
],
"summary": "Get single instance of a share",
"description": "Get single instance of a share",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetShare",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "share-id",
"in": "path",
"description": "Share ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Share"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/shares/default\n{\n \"resource_type\":\"Share\",\n \"id\":\"default\",\n \"display_name\":\"Default Share\",\n \"path\":\"/infra/shares/default\",\n \"relative_path\":\"default\",\n \"parent_path\":\"/infra\",\n \"unique_id\":null,\n \"marked_for_delete\":false,\n \"overridden\":false,\n \"_create_user\":\"system\",\n \"_system_owned\":true,\n \"_last_modified_user\":\"system\",\n \"_create_time\":1613557631201,\n \"_last_modified_time\":1613557631201,\n \"_protection\":\"NOT_PROTECTED\",\n \"_revision\":0\n}\n",
"x-vmw-nsx-module": "PolicyShare",
"x-vmw-nsx-example-response": "200 OK"
},
"put": {
"tags": [
"Policy",
"Multi Tenancy",
"Shared Resource"
],
"summary": "Create or update a Share",
"description": "If a Share with the given ID already exists, and the revision is 0, throw error\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateShare",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "share-id",
"in": "path",
"description": "Share ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Share"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Share"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/shares/share1\n{\n \"resource_type\":\"Share\",\n \"display_name\":\"My Share\",\n \"sharedWith\":[\n \"/orgs/default/projects/project1\"\n ],\n \"_revision\":0\n}\n",
"x-vmw-nsx-module": "PolicyShare",
"x-vmw-nsx-example-response": "{\n \"resource_objects\":[\n {\n \"resource_path\": \"/infra/domains/domain1/groups/group1\",\n \"include_children\": false\n }\n ],\n \"resource_type\":\"Share\",\n \"id\":\"backup\",\n \"display_name\":\"backup\",\n \"path\":\"/infra/shares/share1\",\n \"relative_path\":\"share1\",\n \"parent_path\":\"/infra\",\n \"unique_id\":null,\n \"marked_for_delete\":false,\n \"overridden\":false,\n \"_create_user\":\"admin\",\n \"_system_owned\":false,\n \"_last_modified_user\":\"admin\",\n \"_create_time\":1613559460360,\n \"_last_modified_time\":1613559460360,\n \"_protection\":\"NOT_PROTECTED\",\n \"_revision\":0\n}\n",
"x-codegen-request-body-name": "Share"
},
"delete": {
"tags": [
"Policy",
"Multi Tenancy",
"Shared Resource"
],
"summary": "Delete Share",
"description": "Delete a Share.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteShare",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "share-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/shares/share1\n",
"x-vmw-nsx-module": "PolicyShare",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Multi Tenancy",
"Shared Resource"
],
"summary": "Create or update a Share",
"description": "If a Share with the given ID already exists, update the share entity.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchShare",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "share-id",
"in": "path",
"description": "Share ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Share"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/shares/share1\n{\n \"resource_type\":\"Share\",\n \"display_name\":\"My Share\",\n \"sharedWith\":[\n \"/orgs/default/projects/project1\"\n ],\n \"_revision\":0\n}\n",
"x-vmw-nsx-module": "PolicyShare",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "Share"
}
},
"/global-infra/tier-0s/{tier-0-id}/dns-forwarder": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Read the DNS Forwarder for the given tier-0 instance",
"description": "Read the DNS Forwarder for the given tier-0 instance",
"operationId": "GlobalInfraReadPolicyDnsForwarderOnTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyDnsForwarder\",\n \"id\" : \"dns-forwarder\",\n \"display_name\" : \"dns-forwarder\",\n \"path\" : \"/infra/tier-0s/prv/dns-forwarder\",\n \"parent_path\" : \"/infra/tier-0s/prv\",\n \"relative_path\" : \"dns-forwarder\",\n \"listener_ip\" : \"5.5.5.5\",\n \"conditional_forwarder_zone_paths\" : [ \"/infra/dns-forwarder-zones/conditional-1\" ],\n \"log_level\" : \"INFO\",\n \"enabled\" : true,\n \"default_forwarder_zone_path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n"
},
"post": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Perform the specified DNS forwarder action",
"description": "Perform the specified action for Tier0 DNS forwarder on specified enforcement point.\n",
"operationId": "GlobalInfraPerformEPActionForDnsForwarderAtTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "An action to be performed for DNS forwarder on EP",
"required": true,
"schema": {
"type": "string",
"enum": [
"clear_cache"
]
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "An enforcement point path, on which the action is to be performed",
"schema": {
"type": "string",
"default": "/infra/sites/default/enforcement-points/default"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "1. Clear cache\nPOST https://<policy-mgr>/policy/api/v1/infra/tier-0s/tier0/dns-forwarder?action=clear_cache\n",
"x-vmw-nsx-module": "PolicyDnsForwarder"
}
},
"/infra/segments/{segment-id}?force=true": {
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Create or update a infra segment",
"description": "If segment with the segment-id is not already present, create a new segment.\nIf it already exists, replace the segment with this object.\n\nForce parameter is required when workload connectivity is indirectly impacted\nwith the current replacement.\nNote:\n Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the\n \"l2_extension\" object in the PATCH API payload, the path returned in the GET response payload may include the new path\n instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.\n Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path\n instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.\n",
"operationId": "CreateOrReplaceInfraSegmentWithForce",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/segments/web-tier?force=true\n {\n \"display_name\":\"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [ \"40.1.2.0/24\" ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\",\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Segment\",\n \"id\": \"web-tier\",\n \"display_name\": \"web-tier\",\n \"path\": \"/infra/tier-1s/cgw/segments/web-tier\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [\n \"40.1.2.0/24\"\n ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668961954,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668961954,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "Segment"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Force delete infra segment",
"description": "Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.",
"operationId": "ForceDeleteInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cascade",
"in": "query",
"description": "Flag to specify whether to delete related segment ports",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/segments/web-tier\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Create or update a segment",
"description": "If segment with the segment-id is not already present, create a new segment.\nIf it already exists, update the segment with specified attributes.\n\nForce parameter is required when workload connectivity is indirectly impacted\nwith the current update.\n",
"operationId": "PatchInfraSegmentWithForce",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/segments/web-tier>?force=true\n {\n \"display_name\":\"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [ \"40.1.2.0/24\" ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\"\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "Segment"
}
},
"/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Status"
],
"summary": "Get IPSec VPN session detailed status under Tier-0",
"description": "- no enforcement point path specified: detailed status is evaluated on each enforcement point.\n- an enforcement point path is specified: detailed status is evaluated only on the given\nenforcement point.\n- source=realtime: detailed status is fetched realtime from the enforcement point.\n- source=cached: cached detailed status from enforcement point is returned.\n",
"operationId": "GetTier0VpnIPSecVpnSessionStatus",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateIPSecVpnSessionStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/rbs-1/detailed-status\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/kubernetes-ingresses": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get kubernetes ingress policies that belong to this Group",
"description": "Get kubernetes ingress policies that belong to this Group. This API is applicable for Groups\ncontaining KubernetesIngress member type. For\nGroups containing other member types an empty list is returned\n",
"operationId": "GetGroupKubernetesIngressMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster_id",
"in": "query",
"description": "Cluster ID",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupKubernetesIngressListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/kubernetes-ingresses?cluster_id=6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"clusters\": [\n {\n \"external_id\": \"6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"ANTK01\",\n \"namespaces\": [\n {\n \"external_id\": \"e0b2ec27-852d-4cc3-9818-b5869e7589e6\",\n \"display_name\": \"kube-node-lease\",\n \"kubernetes_ingresses\": [\n {\n \"external_id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"nginx-example\",\n \"load_balance_ingress_ip_addresses\": [\n \"10.10.1.0\",\n \"10.10.2.0\",\n \"\"\n ]\n },\n {\n \"external_id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"ingress-resource-backend\",\n \"load_balance_ingress_ip_addresses\": [\n \"10.10.3.0\",\n \"10.10.4.0\",\n \"\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n\"result_count\": 2,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-1 router link statistics information",
"description": "Get tier-1 router link statistics information for the linked tier-0 interface.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1RouterLinkStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/production_t1/tier-0-interface/statistics?edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/2bffe9c5-ffba-4917-b2e1-53fa70619189/edge-nodes/0\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_router_port_id\": \"/infra/tier-1s/production_t1\",\n \"per_node_statistics\": [\n {\n \"transport_node_id\": \"/infra/sites/default/enforcement-points/default/edge-transport-node/0167b052-b427-11ee-8699-0645394f4d47\",\n \"last_update_timestamp\": 1705966786953,\n \"rx\": {\n \"total_bytes\": 920,\n \"total_packets\": 15,\n \"dropped_packets\": 4,\n \"blocked_packets\": 0,\n \"destination_unsupported_dropped_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"ipv6_dropped_packets\": 4,\n \"kni_dropped_packets\": 0,\n \"l4port_unsupported_dropped_packets\": 0,\n \"malformed_dropped_packets\": 0,\n \"no_receiver_dropped_packets\": 0,\n \"no_route_dropped_packets\": 0,\n \"proto_unsupported_dropped_packets\": 0,\n \"redirect_dropped_packets\": 0,\n \"rpf_check_dropped_packets\": 0,\n \"ttl_exceeded_dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 111720,\n \"total_packets\": 2660,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"dad_dropped_packets\": 0,\n \"frag_needed_dropped_packets\": 0,\n \"ipsec_pol_block_dropped_packets\": 0,\n \"ipsec_pol_err_dropped_packets\": 0,\n \"no_arp_dropped_packets\": 0,\n \"no_linked_dropped_packets\": 0,\n \"no_mem_dropped_packets\": 0,\n \"non_ip_dropped_packets\": 0,\n \"service_insert_dropped_packets\": 0\n }\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Remote-Mac"
],
"summary": "Get L2Vpn session remote mac for logical switch",
"description": "Returns L2Vpn session remote macs for a logical switch.\nData is fetched from enforcement point.\n\n
\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/\nsessions/<session-id>/remote-mac instead.\n",
"operationId": "GetTier0L2VpnSessionRemoteMacsForLS",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "segment_path",
"in": "query",
"description": "Segment Path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VpnSessionRemoteMac"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/int_net/locale-services/default/l2vpn-services/default/sessions/default/remote-mac\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": "{\n \"display_name\": \"default-l2vpn-session\",\n \"remote_macs\": [\n {\n \"remote_mac_addresses\": [\n 00:0a:95:9d:68:16\n ],\n \"segment_path\": \"/infra/tier-0s/default-tier0-id/segments/default-segment-id\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Revise the positioning of IDS rule",
"description": "This is used to re-order a rule within a security policy.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReviseIdsRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp12/rules/Test-Rule12?action=revise&anchor_path=/infra/domains/default/intrusion-service-policies/sp12/rules/sptestRule&operation=insert_after\n {\n \"action\": \"DETECT\",\n \"ids_profiles\": [\n \"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\"\n ],\n \"resource_type\": \"IdsRule\",\n \"id\": \"Test-Rule12\",\n \"display_name\": \"Test-Rule12\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp12/rules/Test-Rule12\",\n \"relative_path\": \"Test-Rule12\",\n \"parent_path\": \"/infra/domains/default/intrusion-service-policies/sp12\",\n \"unique_id\": \"2024\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"rule_id\": 2024,\n \"sequence_number\": 50,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"ANY\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"logged\": true,\n \"scope\": [\n \"ANY\"\n ],\n \"disabled\": true,\n \"direction\": \"IN\",\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711476003,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714267564,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n }\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"action\": \"DETECT\",\n \"ids_profiles\": [\n \"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\"\n ],\n \"resource_type\": \"IdsRule\",\n \"id\": \"Test-Rule12\",\n \"display_name\": \"Test-Rule12\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp12/rules/Test-Rule12\",\n \"relative_path\": \"Test-Rule12\",\n \"parent_path\": \"/infra/domains/default/intrusion-service-policies/sp12\",\n \"unique_id\": \"2024\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"rule_id\": 2024,\n \"sequence_number\": 400,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"ANY\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"logged\": true,\n \"scope\": [\n \"ANY\"\n ],\n \"disabled\": true,\n \"direction\": \"IN\",\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711476003,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714321618,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 4\n }\n",
"x-codegen-request-body-name": "IdsRule"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"TEP Table"
],
"summary": "Get tier-1 segment TEP table in CSV",
"description": "Returns TEP table for a segment in CSV\n",
"operationId": "GetTier1SegmentTepTableInCsv",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyTepCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/test-infra-seg/tep-table?format=csv&source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "tep_label,tep_ip,tep_mac_address,segment_id\n55298,100.100.100.3,00:50:56:6a:af:ce,\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"NAT",
"Rules",
"Tier-0 Gateways"
],
"summary": "Get NAT Rule",
"description": "Get NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section\ndenoted by <nat-id>.\nUnder tier-0 there will be 3 different NATs(sections).\n(INTERNAL, USER and DEFAULT)\nFor more details related to NAT section please refer to PolicyNAT schema.\nNote:\n IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the\n scope property in the PUT/PATCH API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path\n Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.\n",
"operationId": "GlobalInfraGetPolicyNatRuleFromTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyNatRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_provider-demo/nat/USER/nat-rules/MyNATRule3\n",
"x-vmw-nsx-module": "PolicyNAT",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyNatRule\",\n \"description\": \"Example of a NAT rule\",\n \"id\": \"MyNATRule3\",\n \"display_name\": \"MyNATRule3\",\n \"path\": \"/infra/tier-0s/vmc_provider-demo//nat/USER/nat-rules/MyNATRule3\",\n \"parent_path\": \"/infra/tier-0s/vmc_provider-demo/nat/USER\",\n \"relative_path\": \"MyNATRule3\",\n \"sequence_number\": 10,\n \"service\": \"/infra/services/AD_Server\",\n \"enabled\": true,\n \"logging\": false,\n \"firewall_match\" : \"MATCH_EXTERNAL_ADDRESS\",\n \"scope\": [],\n \"action\": \"DNAT\",\n \"translated_ports\": \"80-82\",\n \"destination_network\": \"10.117.5.19\",\n \"translated_network\": \"192.168.1.1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516084472276,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516084472276,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/lb-node-usage": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Usage",
"Usage"
],
"summary": "Read load balancer usage for the given node",
"description": "API is used to retrieve node usage for load balancer which contains basic\ninformation, LB entity usages and capacities for the given node.\nCurrently only edge node is supported.\nThe parameter ?node_path=<node-path> is required. For example, ?node_path=\n/infra/sites/default/enforcement-points/default/edge-clusters/\n85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes/\n86e077c0-449f-11e9-87c8-02004eb37029.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "GetLBNodeUsage",
"parameters": [
{
"name": "node_path",
"in": "query",
"description": "The node path for load balancer node usage",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBNodeUsage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyLBStatistics"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from tier-1 router link interface in CSV format",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format\nfor the tier-1 router link interface.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1RouterLinkArpTableCsv",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n}\n"
}
},
"/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Get Infra Segment Discovery Profile Binding Map",
"description": "API will get Infra Segment Discovery Profile Binding Map\n",
"operationId": "GetInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Update Infra Segment Discovery Profile Binding Map",
"description": "API will update Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "UpdateInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n{\n \"resource_type\":\" SegmentDiscoveryProfileBindingMap\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SegmentDiscoveryProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Delete Segment Discovery Profile Binding Profile",
"description": "API will delete Segment Discovery Profile Binding Profile",
"operationId": "DeleteInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Create Infra Segment Discovery Profile Binding Map",
"description": "API will create Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "PatchInfraSegmentDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-discovery-profile-binding-map-id",
"in": "path",
"description": "Segment Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\n {\n \"resource_type\":\" SegmentDiscoveryProfileBindingMap\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n }\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-codegen-request-body-name": "SegmentDiscoveryProfileBindingMap"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier1-id}/session-timer-profile-bindings/{session-timer-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Get Session Timer Profile Binding Map for Tier-1 Logical Router",
"description": "API will get Session Timer Profile Binding Map for Tier-1 Logical Router.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1SessionTimerProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-1 Logical Router",
"description": "API will create or update Session Timer profile binding map for Tier-1 Logical Router.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateTier1SessionTimerProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/session-timer-profile-bindings/default\n {\n \"resource_type\":\"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Delete Session Timer Profile Binding for Tier-1 Logical Router",
"description": "API will delete Session Timer Profile Binding for Tier-1 Logical Router.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTier1SessionTimerProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-1 Logical Router",
"description": "API will create or update Session Timer profile binding map for Tier-1 Logical Router.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchTier1SessionTimerProfileBindingMap",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/session-timer-profile-bindings/default\n {\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Locale Services"
],
"summary": "Read Tier-1 locale-services",
"description": "Read Tier-1 locale-services",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadTier1LocaleServices",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services/palo_alto\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LocaleServices\",\n \"id\": \"palo_alto\",\n \"display_name\": \"Palo Alto\",\n \"path\": \"/infra/tier-1s/cgw/locale-services/default\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"palo_alto\",\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Locale Services"
],
"summary": "Create or update a Tier-1 locale-services",
"description": "If a Tier-1 locale services with the locale-services-id is not already\npresent, create a new locale-services. If it already exists, replace the\nTier-1 locale services instance with the new object.\n\nModifying edge cluster re-allocates NSX service routers of TIER1 to a different edge\ncluster. You can also place edge nodes manually and provide maximum two indices\nfor HA mode ACTIVE_STANDBY. To re-allocating edge cluster is a disruptive operation\nand all existing statistics of Tier1 gateway will be removed.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrReplaceTier1LocaleServices",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services/palo_alto\n{\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LocaleServices\",\n \"id\": \"palo_alto\",\n \"display_name\": \"Palo Alto\",\n \"path\": \"/infra/tier-1s/cgw/locale-services/palo_alto\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"palo_alto\",\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "LocaleServices"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Locale Services"
],
"summary": "Delete Tier-1 locale-services",
"description": "Delete Tier-1 locale-services",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTier1LocaleServices",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services/default\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Locale Services"
],
"summary": "Create or update a Tier-1 locale-services",
"description": "If a Tier-1 locale services with the locale-services-id is not already\npresent, create a new locale services. If it already exists, update\nTier-1 locale services with specified attributes.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchTier1LocaleServices",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services/palo_alto\n{\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ]\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "LocaleServices"
}
},
"/global-infra/segments/{segment-id}/ports": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "List infra segment ports",
"description": "List all the ports for an infra.\n",
"operationId": "GlobalInfraListInfraSegmentPorts",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/production-t1-seg/ports/\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"resource_type\": \"SegmentPort\",\n \"id\": \"default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"display_name\": \"default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"path\": \"/infra/segments/production-t1-seg/ports/default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"relative_path\": \"default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"parent_path\": \"/infra/segments/production-t1-seg\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1544503100539,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1544503100539,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"SegmentPort\",\n \"id\": \"default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"display_name\": \"default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"path\": \"/infra/segments/production-t1-seg/ports/default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"relative_path\": \"default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"parent_path\": \"/infra/segments/production-t1-seg\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1544503100542,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1544503100542,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"SegmentPort\",\n \"id\": \"default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"display_name\": \"default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"path\": \"/infra/segments/production-t1-seg/ports/default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"relative_path\": \"default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"parent_path\": \"/infra/segments/production-t1-seg\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1544503100524,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1544503100524,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 3,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Proxies"
],
"summary": "Get Tier-0 Interface Address Resolution Protocol Proxies",
"description": "Returns ARP proxy table for a tier-0 interface. Interfaces can be of types\n- EXTERNAL and SERVICE. Interfaces of type LOOBACK and downlink are not\nsupported.\n",
"operationId": "GlobalInfraGetTier0InterfaceArpProxies",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-1340/interfaces/my-if/arp-proxy\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/infra/service-chains/{service-chain-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Chains"
],
"summary": "Read service chain",
"description": "This API can be used to read service chain with given service-chain-id.",
"operationId": "ReadServiceChain",
"parameters": [
{
"name": "service-chain-id",
"in": "path",
"description": "Id of Service chain",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyServiceChain"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/service-chains/<psc-id>\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n\"forward_path_service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_1\",\n \"/infra/service-references/SR_1/service-profiles/SP_2\"\n],\n\"reverse_path_service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_2\",\n \"/infra/service-references/SR_1/service-profiles/SP_1\"\n],\n\"service_segment_path\": [\n \"/infra/segments/service-segments/SS_1\"\n],\n\"failure_policy\": \"ALLOW\",\n\"path_selection_policy\": \"ANY\",\n\"resource_type\": \"PolicyServiceChain\",\n\"id\": \"PSC_1\",\n\"display_name\": \"PSC_1\",\n\"description\": \"PSC_1 Desc\",\n\"path\": \"/infra/service-chains/PSC_1\",\n\"relative_path\": \"PSC_1\",\n\"parent_path\": \"/infra/service-chains/PSC_1\",\n\"marked_for_delete\": false,\n\"_create_user\": \"admin\",\n\"_create_time\": 1546597502506,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1546597502506,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Chains"
],
"summary": "Create or update service chain",
"description": "Create or update Service chain representing the sequence in which 3rd party\nservices must be consumed.\n",
"operationId": "CreateServiceChain",
"parameters": [
{
"name": "service-chain-id",
"in": "path",
"description": "Service chain id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyServiceChain"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyServiceChain"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/service-chain/SC-1\n{\n \"resource_type\" : \"PolicyServiceChain\",\n \"display_name\" : \"PSC_2 Changed\",\n \"description\" : \"PSC_2 Desc Changed\",\n \"forward_path_service_profiles\":\n [\n \"/infra/service-references/SR_1/service-profiles/SP_1\",\n \"/infra/service-references/SR_1/service-profiles/SP_2\"\n ],\n \"reverse_path_service_profiles\":\n [\n \"/infra/service-references/SR_1/service-profiles/SP_2\",\n \"/infra/service-references/SR_1/service-profiles/SP_1\"\n ],\n \"service_segment_path\":\n [\n \"/infra/segments/service-segments/SS_1\"\n ],\n \"failure_policy\": \"ALLOW\",\n \"path_selection_policy\": \"ANY\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n\"forward_path_service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_1\",\n \"/infra/service-references/SR_1/service-profiles/SP_2\"\n],\n\"reverse_path_service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_2\",\n \"/infra/service-references/SR_1/service-profiles/SP_1\"\n],\n\"service_segment_path\": [\n \"/infra/segments/service-segments/SS_1\"\n],\n\"failure_policy\": \"ALLOW\",\n\"path_selection_policy\": \"ANY\",\n\"resource_type\": \"PolicyServiceChain\",\n\"id\": \"PSC_2\",\n\"display_name\": \"PSC_2 Changed Now\",\n\"description\": \"PSC_2 Desc Changed\",\n\"path\": \"/infra/service-chains/PSC_2\",\n\"relative_path\": \"PSC_2\",\n\"parent_path\": \"/infra/service-chains/PSC_2\",\n\"marked_for_delete\": false,\n\"_create_user\": \"admin\",\n\"_create_time\": 1546597986596,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1546598050671,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PolicyServiceChain"
},
"delete": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Chains"
],
"summary": "Delete Service chain",
"description": "This API can be user to delete service chain with given service-chain-id.",
"operationId": "DeletePolicyServiceChain",
"parameters": [
{
"name": "service-chain-id",
"in": "path",
"description": "Id of Service chain",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/service-chains/PSC_1\n",
"x-vmw-nsx-module": "PolicyServiceInsertion"
},
"patch": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Chains"
],
"summary": "Create service chain",
"description": "Create Service chain representing the sequence in which 3rd party\nservices must be consumed.\n",
"operationId": "PatchServiceChain",
"parameters": [
{
"name": "service-chain-id",
"in": "path",
"description": "Service chain id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyServiceChain"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/service-chain/SC-1\n{\n \"resource_type\" : \"PolicyServiceChain\",\n \"display_name\" : \"PSC_1\",\n \"description\" : \"PSC_1 Desc\",\n \"forward_path_service_profiles\":\n [\n \"/infra/service-references/SR_1/service-profiles/SP_1\",\n \"/infra/service-references/SR_1/service-profiles/SP_2\"\n ],\n \"reverse_path_service_profiles\":\n [\n \"/infra/service-references/SR_1/service-profiles/SP_2\",\n \"/infra/service-references/SR_1/service-profiles/SP_1\"\n ],\n \"service_segment_path\":\n [\n \"/infra/segments/service-segments/SS_1\"\n ],\n \"failure_policy\": \"ALLOW\",\n \"path_selection_policy\": \"ANY\"\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-codegen-request-body-name": "PolicyServiceChain"
}
},
"/infra/tier-0s/{tier-0-id}/prefix-lists": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Prefix List"
],
"summary": "List prefix lists",
"description": "Paginated list of all prefix lists\n",
"operationId": "ListPrefixLists",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrefixListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/prefix-lists\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PrefixList\",\n \"id\": \"to-onprem\",\n \"display_name\": \"/infra/tier-0s/vmc/prefix-lists/to-onprem\",\n \"path\": \"/infra/tier-0s/vmc/prefix-lists/to-onprem\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"to-onprem\",\n \"marked_for_delete\": false,\n \"prefixes\": [\n {\n \"action\": \"PERMIT\",\n \"network\": \"30.1.1.0/24\"\n },\n {\n \"action\": \"DENY\",\n \"network\": \"10.1.1.0/24\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1525754971782,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1525755003657,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table for downlink router port on tier-0 router in CSV",
"description": "Get ARP table for downlink router port on tier-0 router in CSV.\n
\nThis API is deprecated because it is duplicate.\nPlease use /infra/segments/<segment-id>/arp-table?format=csv\nSegment ID is the ID of the segment that is connected to the the tier-0\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetDownlinkPortArpTableForInfraSegmentInCsv",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWNLINK_SWITCH/gateway-interface-arp-table?format=csv&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/7f7d37a7-b78e-4378-949d-09190cbfef7d/edge-nodes/a831390e-a7c8-11ea-9102-020063e79023\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,ip\n00:0c:29:ad:24:e4,192.168.100.163\n00:00:00:00:00:00,192.168.100.161\n00:00:00:00:00:00,192.168.100.160\n"
}
},
"/infra/segments/{segment-id}?action=delete_dhcp_leases": {
"post": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Leases"
],
"summary": "Delete DHCP lease(s) specified by IP and MAC",
"description": "Delete one or multiple DHCP lease(s) specified by IP and MAC.\n\nIf there is a DHCP server running upon the given segment, or this segment\nis using a DHCP server running in its connected Tier-0 or Tier-1, the DHCP\nlease(s) which match exactly the IP address and the MAC address will be\ndeleted. If no such lease matches, the deletion for this lease will be\nignored.\n\nThe DHCP lease to be deleted will be removed by the system from both active\nand standby node. The system will report error if the DHCP lease could not\nbe removed from both nodes. If the DHCP lease could not be removed on either\nnode, please check the DHCP server status. Once the DHCP server status is\nUP, please invoke the deletion API again to ensure the lease gets deleted\nfrom both nodes.\n",
"operationId": "DeleteDhcpLease",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpDeleteLeases"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST /infra/segments/seg-1?action=delete_dhcp_leases\n {\n \"leases\": [\n {\n \"ip\": \"40.1.1.1\",\n \"mac\": \"02:42:21:4d:bc:b7\"\n }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "DhcpDeleteLeases"
}
},
"/aaa/object-permissions": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Authorization",
"Object Permissions"
],
"summary": "Get list of Object-level RBAC entries.",
"description": "Get list of Object-level RBAC entries.",
"operationId": "GetObjectPermissions",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "inheritance_disabled",
"in": "query",
"description": "Does children of this object inherit this rule",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "path_prefix",
"in": "query",
"description": "Path prefix",
"schema": {
"type": "string"
}
},
{
"name": "role_name",
"in": "query",
"description": "Role name",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectRolePermissionGroupListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/aaa/object-permissions?path_prefix=infra/domains/MGW\n",
"x-vmw-nsx-module": "PolicyAuthz",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n \"role_name\": \"cloud_admin\",\n \"operation\": \"crud\",\n \"path_prefix\": \"infra/domains/MGW\"\n },\n {\n \"role_name\": \"cloud_auditor\",\n \"operation\": \"none\",\n \"path_prefix\": \"infra/domains/MGW/CommunicationProfile1\"\n }\n ]\n}\n"
},
"delete": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Authorization",
"Object Permissions"
],
"summary": "Delete object-permissions entries",
"description": "Delete object-permissions entries",
"operationId": "DeleteObjectPermissions",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "inheritance_disabled",
"in": "query",
"description": "Does children of this object inherit this rule",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "path_prefix",
"in": "query",
"description": "Path prefix",
"schema": {
"type": "string"
}
},
{
"name": "role_name",
"in": "query",
"description": "Role name",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/aaa/object-permissions?role_name=cloud_admin&path_prefix=infra/domains/MGW\n",
"x-vmw-nsx-module": "PolicyAuthz",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Authorization",
"Object Permissions"
],
"summary": "Create/update object permission mappings",
"description": "Create/update object permission mappings",
"operationId": "UpdateObjectPermissions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectRolePermissionGroup"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/aaa/object-permissions\n{\n \"role_name\": \"cloud_admin\",\n \"operation\": \"crud\",\n \"path_prefix\": \"infra/MGW\"\n}\n",
"x-vmw-nsx-module": "PolicyAuthz",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "ObjectRolePermissionGroup"
}
},
"/infra/firewall-identity-store-size": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Scan the size of a directory domain",
"description": "This call scans the size of a directory domain. It may be very | expensive to run this call in some AD domain deployments. Please | use it with caution.",
"operationId": "ScanFirewallIdentityStoreSize",
"parameters": [
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryDomain"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryDomainSize"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-store-size\n{\n \"resource_type\": \"DirectoryAdDomain\",\n \"description\": \"Active directory domain nimbustest.com\",\n \"display_name\": \"NIMBUS TEST\",\n \"base_distinguished_name\": \"DC=nimbustest,DC=com\",\n \"netbios_name\": \"NIMBUSTEST\",\n \"name\": \"nimbustest.com\",\n \"ldap_servers\": [\n {\n \"resource_type\": \"DirectoryAdLdapServer\",\n \"display_name\": \"nimbus ldap\",\n \"host\": \"10.192.210.96\",\n \"username\": \"dummy\",\n \"password\": \"dummy\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"port\": 389,\n \"protocol\": \"LDAP\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"user_count\": 52712,\n \"group_count\": 100053,\n \"group_member_count\": 1000027\n}\n",
"x-codegen-request-body-name": "DirectoryDomain"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/csrs?action=self_sign": {
"post": {
"tags": [
"Policy",
"Infra",
"Certificates",
"CSR"
],
"summary": "Generate a new self-signed certificate",
"description": "Creates a new self-signed certificate. A private key is also created at the\nsame time. This is convenience call that will generate a CSR and then self-sign it.\nThe maximum validity limit for non-CA certificates is 825 days, except that values\nof 3,650 and 36,500 days are allowed. No limit is set for CA certificates.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGenerateSelfSignedTlsCertificate",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCsrWithDaysValid"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCertificate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/csrs?action=self_sign\n{\n \"subject\":\n {\n \"attributes\":\n [\n {\"key\":\"CN\",\"value\":\"Jane\"},\n {\"key\":\"O\",\"value\":\"VMware\"},\n {\"key\":\"OU\",\"value\":\"NSBU\"},\n {\"key\":\"C\",\"value\":\"US\"},\n {\"key\":\"ST\",\"value\":\"CA\"},\n {\"key\":\"L\",\"value\":\"PA\"}\n ]\n },\n \"key_size\": \"2048\",\n \"algorithm\": \"RSA\",\n \"days_valid\": 365,\n}\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"TlsCertificate\",\n \"id\": \"669f4e8f-061e-4c73-8cfb-1044181eb365\",\n \"display_name\": \"example-csr-id\",\n \"path\": \"/infra/certificates/669f4e8f-061e-4c73-8cfb-1044181eb365\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"669f4e8f-061e-4c73-8cfb-1044181eb365\",\n \"details\": [\n {\n \"issuer_cn\": \"Jane\",\n \"public_key_length\": 1024,\n \"signature\": \"4e cf ff 36 ac a1\",\n \"not_before\": 1323772715000,\n \"subject\": \"CN=Jane,O=VMware,OU=NSBU,ST=CA,C=US,PA=L\",\n \"serial_number\": \"ca55f5e21a0b2dd2\",\n \"public_key_algo\": \"RSA\",\n \"version\": \"1\",\n \"issuer\": \"CN=Jane,O=VMware,OU=NSBU,ST=CA,C=US,PA=L\",\n \"is_ca\": false,\n \"subject_cn\": \"Jane\",\n \"not_after\": 1355308715000,\n \"is_valid\": false,\n \"rsa_public_key_exponent\": \"10001\",\n \"signature_algorithm\": \"SHA1WITHRSA\",\n \"rsa_public_key_modulus\": \"00 b7 8f 79 e4\"\n }\n ],\n \"pem_encoded\": \"-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n\",\n \"has_private_key\": true,\n \"tls_certificate_type\": \"CERTIFICATE_SELF_SIGNED\",\n \"unique_id\": \"669f4e8f-061e-4c73-8cfb-1044181eb365\",\n \"realization_id\": \"669f4e8f-061e-4c73-8cfb-1044181eb365\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516338671237,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516338671237,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "TlsCsrWithDaysValid"
}
},
"/aaa/ldap-identity-sources/{ldap-identity-source-id}": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"LDAP Identity Sources"
],
"summary": "Read a single LDAP identity source",
"description": "Return details about one LDAP identity source",
"operationId": "ReadLdapIdentitySource",
"parameters": [
{
"name": "ldap-identity-source-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapIdentitySource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET /policy/api/v1/aaa/ldap-identity-sources/airius-ad\n",
"x-vmw-nsx-module": "LdapIdentitySources",
"x-vmw-nsx-example-response": "200 OK\n{\n \"id\": \"airius-ad\",\n \"resource_type\": \"ActiveDirectoryIdentitySource\",\n \"display_name\": \"Airius LDAP\",\n \"domain_name\": \"airius.com\",\n \"base_dn\": \"DC=airius, DC=com\",\n \"ldap_servers\": [\n \"url\": \"ldap://ldap-vip01.corp.airius.com\",\n \"use_starttls\": true,\n \"bind_identity\": \"nsxint@airius.com\",\n \"certificates\": [\n \"BEGIN_CERTIFICATE <certificate> END_CERTIFICATE\",\n ]\n ],\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1531939962695,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1531936487738,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"System Administration",
"Settings",
"User Management",
"LDAP Identity Sources"
],
"summary": "Create or update an LDAP identity source",
"description": "Create a new LDAP identity source or update the configuration of an existing LDAP identity source. You may wish to verify the new configuration using the POST /aaa/ldap-identity-sources?action=probe API before creating or changing the configuration. Note that if you are using LDAP on an active and standby NSX-T Global Manager in a federated environment, you must use the same name for your LDAP identity sources on the active and standby Global Managers.",
"operationId": "CreateOrUpdateLdapIdentitySource",
"parameters": [
{
"name": "ldap-identity-source-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapIdentitySource"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapIdentitySource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT /policy/api/v1/aaa/ldap-identity-sources/airius-ad\n{\n \"id\": \"airius-ad\",\n \"resource_type\": \"ActiveDirectoryIdentitySource\",\n \"display_name\": \"Airius LDAP\",\n \"domain_name\": \"airius.com\",\n \"base_dn\": \"DC=airius, DC=com\",\n \"ldap_servers\": [\n \"url\": \"ldap://ldap-vip01.corp.airius.com\",\n \"use_starttls\": true,\n \"bind_identity\": \"nsxint@airius.com\",\n \"password\": \"forever big xray tempo\"\n \"certificates\": [\n \"BEGIN_CERTIFICATE <certificate> END_CERTIFICATE\",\n ]\n ],\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "LdapIdentitySources",
"x-vmw-nsx-example-response": "200 OK\n{\n \"id\": \"airius-ad\",\n \"resource_type\": \"ActiveDirectoryIdentitySource\",\n \"display_name\": \"Airius LDAP\",\n \"domain_name\": \"airius.com\",\n \"base_dn\": \"DC=airius, DC=com\",\n \"ldap_servers\": [\n \"url\": \"ldap://ldap-vip01.corp.airius.com\",\n \"use_starttls\": true,\n \"bind_identity\": \"nsxint@airius.com\",\n \"certificates\": [\n \"BEGIN_CERTIFICATE <certificate> END_CERTIFICATE\",\n ]\n ],\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1531939962695,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1531936487738,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "LdapIdentitySource"
},
"delete": {
"tags": [
"System Administration",
"Settings",
"User Management",
"LDAP Identity Sources"
],
"summary": "Delete an LDAP identity source",
"description": "Delete an LDAP identity source. Users defined in that source will no longer be able to access NSX.",
"operationId": "DeleteLdapIdentitySource",
"parameters": [
{
"name": "ldap-identity-source-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE /policy/api/v1/aaa/ldap-identity-sources/airius-ad\n",
"x-vmw-nsx-module": "LdapIdentitySources",
"x-vmw-nsx-example-response": "200 OK\n"
}
},
"/infra/tier-0s/{tier-0-id}/tier-1-interface/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-0 router link statistics information",
"description": "Get tier-0 router link statistics information for a given linked tier-1 interface.\n",
"operationId": "GetTier0RouterLinkStatistics",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "tier1_path",
"in": "query",
"description": "Policy path of tier1",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/pepsi/tier-1-interface/statistics?tier1_path=/infra/tier-1s/production_t1&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/2bffe9c5-ffba-4917-b2e1-53fa70619189/edge-nodes/0\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_router_port_id\": \"/infra/tier-0s/pepsi\",\n \"per_node_statistics\": [\n {\n \"transport_node_id\": \"/infra/sites/default/enforcement-points/default/edge-transport-node/0167b052-b427-11ee-8699-0645394f4d47\",\n \"last_update_timestamp\": 1705967015667,\n \"rx\": {\n \"total_bytes\": 111972,\n \"total_packets\": 2666,\n \"dropped_packets\": 401\n },\n \"tx\": {\n \"total_bytes\": 1712,\n \"total_packets\": 26,\n \"dropped_packets\": 0\n }\n }\n ]\n}\n"
}
},
"/alb/controller-nodes/check-password": {
"put": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Password Check"
],
"summary": "Validate admin password for ALB Controller.",
"description": "Use this API to validate admin password in ALB Controller.\nThis API is for VCF deployments only.\n",
"operationId": "AdminCheckPassword",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerAdminCredential"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/alb/controller-nodes/password-check\n{\n \"password\": \"abcdef123\",\n \"clustering_id\": \"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n}\n",
"x-vmw-nsx-module": "PolicyALBControllerOnBoarding",
"x-codegen-request-body-name": "ALBControllerAdminCredential"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/realized-state/virtual-machines/{virtual-machine-id}/tags": {
"post": {
"tags": [
"Policy",
"Inventory",
"Virtual Machines"
],
"summary": "Apply tags on virtual machine",
"description": "Allows an admin to apply multiple tags to a virtual machine. This operation\ndoes not store the intent on the policy side. It applies the tag directly\non the specified enforcement point. This operation will replace the existing\ntags on the virtual machine with the ones that have been passed. If the\napplication of tag fails on the enforcement point, then an error is\nreported. The admin will have to retry the operation again. Policy\nframework does not perform a retry. Failure could occur due to multiple\nreasons. For e.g enforcement point is down, Enforcement point could not\napply the tag due to constraints like max tags limit exceeded, etc.\nNOTE: The \"virtual_machine_id\" field in the payload will be ignored and the\nvirtual machine ID provided in the URL will be honored.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraApplyTagOnVirtualMachine",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "virtual-machine-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineTagsUpdate"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/realized-state/virtual-machines//tags\n{\n \"tags\": [\n {\"scope\": \"web\", \"tag\": \"web-vm\"},\n {\"scope\": \"ostype\", \"tag\": \"WINDOWS\"}\n ]\n}\n",
"x-vmw-nsx-module": "PolicyRealizedState",
"x-codegen-request-body-name": "VirtualMachineTagsUpdate"
}
},
"/global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes BFD Peers"
],
"summary": "Read a StaticRouteBfdPeer",
"description": "Read a StaticRouteBfdPeer with the bfd-peer-id.\n",
"operationId": "GlobalInfraReadStaticRouteBfdPeer",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bfd-peer-id",
"in": "path",
"description": "BFD peer ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRouteBfdPeer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/t0/static-routes/bfd-peers/peer2\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"enabled\": true,\n \"peer_address\": \"10.1.1.2\",\n \"bfd_profile_path\": \"/infra/bfd-profiles/config2\",\n \"resource_type\": \"StaticRouteBfdPeer\",\n \"id\": \"peer2\",\n \"display_name\": \"peer2\",\n \"path\": \"/infra/tier-0s/pepsi/static-routes/bfd-peers/peer2\",\n \"relative_path\": \"peer2\",\n \"parent_path\": \"/infra/tier-0s/pepsi\",\n \"unique_id\": \"3ba5025a-49aa-402b-9c4b-e41088e5ed9e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579289979989,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579289979989,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Network Services",
"NAT"
],
"summary": "Get NAT Rule",
"description": "Get NAT Rule from VPC denoted by VPC ID, under NAT section\ndenoted by <nat-id>.\nUnder VPC there will be 2 different NATs(sections).\n(USER and NAT64)\nFor more details related to NAT section please refer to PolicyNAT schema.\n",
"operationId": "GetPolicyVpcNatRuleOnVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "Org ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "Project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"description": "VPC ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyVpcNatRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/vpcs/vpc1/nat/USER/nat-rules/MyNATRule3\n",
"x-vmw-nsx-module": "PolicyVpcNat",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyVpcNatRule\",\n \"description\": \"Example of a NAT rule\",\n \"id\": \"MyNATRule3\",\n \"display_name\": \"MyNATRule3\",\n \"path\": \"/orgs/org1/projects/project1/vpcs/vpc1/nat/USER/nat-rules/MyNATRule3\",\n \"parent_path\": \"/orgs/org1/projects/project1/vpcs/vpc1/nat/USER\",\n \"relative_path\": \"MyNATRule3\",\n \"sequence_number\": 10,\n \"action\": \"DNAT\",\n \"destination_network\": \"10.117.5.19\",\n \"translated_network\": \"192.168.1.1\",\n \"enabled\" : true,\n \"logging\" : false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516084472276,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516084472276,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Network Services",
"NAT"
],
"summary": "Update NAT Rule",
"description": "Update NAT Rule on VPC denoted by VPC ID, under NAT section\ndenoted by <nat-id>.\nUnder VPC there will be 2 different NATs(sections).\n(USER and NAT64)\nFor more details related to NAT section please refer to PolicyNAT schema.\n",
"operationId": "CreateOrReplacePolicyNatRuleOnVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "Org ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "Project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"description": "VPC ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyVpcNatRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyVpcNatRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/vpcs/vpc1/nat/USER/nat-rules/MyNATRuleDemo\n{\n \"display_name\" : \"MyNATRuleDemo\",\n \"description\" : \"Example of a NAT rule\",\n \"action\" : \"DNAT\",\n \"destination_network\" : \"10.117.5.19\",\n \"translated_network\" : \"192.168.1.1\",\n \"sequence_number\" : 10,\n \"enabled\" : true,\n \"logging\" : false,\n \"firewall_match\" : \"MATCH_EXTERNAL_ADDRESS\"\n}\n",
"x-vmw-nsx-module": "PolicyVpcNat",
"x-vmw-nsx-example-response": "{\n\"resource_type\": \"PolicyVpcNatRule\",\n\"description\": \"Example of a NAT rule\",\n\"id\": \"MyNATRuleDemo\",\n\"display_name\": \"MyNATRuleDemo\",\n\"path\": \"/orgs/org1/projects/project1/vpcs/vpc1/nat/USER/nat-rules/MyNATRuleDemo\",\n\"parent_path\": \"/orgs/org1/projects/project1/vpcs/vpc1/nat/USER\",\n\"relative_path\": \"MyNATRuleDemo\",\n\"sequence_number\": 10,\n\"action\": \"DNAT\",\n\"destination_network\": \"10.117.5.19\",\n\"translated_network\": \"192.168.1.1\",\n\"enabled\" : true,\n\"logging\" : false,\n\"firewall_match\" : \"MATCH_EXTERNAL_ADDRESS\",\n\"_create_user\": \"admin\",\n\"_create_time\": 1516181809835,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1516181809835,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyVpcNatRule"
},
"delete": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Network Services",
"NAT"
],
"summary": "Delete NAT Rule",
"description": "Delete NAT Rule from VPC denoted by VPC ID, under NAT section denoted by <nat-id>. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema.",
"operationId": "DeletePolicyNatRuleOnVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "Org ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "Project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"description": "VPC ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/vpcs/vpc1/nat/USER/nat-rules/MyNATRule4\n",
"x-vmw-nsx-module": "PolicyVpcNat"
},
"patch": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Network Services",
"NAT"
],
"summary": "Create or update a Nat Rule",
"description": "If a NAT Rule is not already present on VPC denoted by VPC ID,\nunder NAT section denoted by <nat-id>, create a new NAT Rule.\nIf it already exists, update the NAT Rule.\nUnder VPC there will be 2 different NATs(sections).\n(USER and NAT64)\nFor more details related to NAT section please refer to PolicyNAT schema.\n",
"operationId": "PatchPolicyVpcNatRuleOnVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "Org ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "Project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"description": "VPC ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyVpcNatRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/vpcs/vpc1/nat/USER/nat-rules/MyNATRuleDemo\n{\n \"display_name\" : \"MyNATRuleDemo\",\n \"description\" : \"Example of a NAT rule\",\n \"action\" : \"DNAT\",\n \"destination_network\" : \"10.117.5.19\",\n \"translated_network\" : \"192.168.1.1\",\n \"sequence_number\" : 10,\n \"enabled\" : true,\n \"logging\" : false\n}\n",
"x-vmw-nsx-module": "PolicyVpcNat",
"x-codegen-request-body-name": "PolicyVpcNatRule"
}
},
"/global-infra/tier-1s/{tier-1-id}/arp-proxies?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"ARP Proxies"
],
"summary": "Get Tier-1 Address Resolution Protocol Proxies in CSV format",
"description": "Returns ARP proxy table for a tier-1 in CSV format\n",
"operationId": "GlobalInfraGetTier1GatewayArpProxiesInCsv",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s/pepsi/arp-proxies?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "TODO smanikarnike\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-proxy": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments"
],
"summary": "Get downlink port Address Resolution Protocol Proxies for infra segment",
"description": "Returns ARP proxy table for downlink port on connected to the segment\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetDownlinkPortArpProxiesForInfraSegment",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/segments/test-segment/arp-proxy\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/infra/settings/firewall/export": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Task"
],
"summary": "Get the information of export task",
"description": "Get the information of the latest export task.\n",
"operationId": "GetExportTask",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export\n",
"x-vmw-nsx-module": "PolicyTask",
"x-vmw-nsx-example-response": "{\n \"id\": \"export_task\",\n \"status\": \"success\",\n \"description\": \"Export of the current firewall configuration.\",\n \"exported_file\": \"fw_config_apr2020.zip\",\n \"failure_msg\": null,\n \"user\": \"admin\",\n \"start_time\": 1587491995996,\n \"end_time\": 1587491996432\n}\n"
},
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Task"
],
"summary": "Invoke export task",
"description": "Invoke export task. There can be only one export task run at any point of\ntime. Hence invocation of another export task will be discarded, when there\nexist an already running export task.\nExported configuration will be in a CSV format. This CSV file will be zipped\ninto a ZIP file, that can be downloaded after the completion of export task.\n",
"operationId": "InvokeExportTask",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportRequestParameter"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "1. Export of current firewall configuration,\nPOST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export\n{\n \"passphrase\": \"AA12!@bb\"\n}\n\n2. Export of the draft,\nPOST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export\n{\n \"passphrase\": \"AA12!@bb\",\n \"draft_path\": \"/infra/drafts/draft1\"\n}\n",
"x-vmw-nsx-module": "PolicyTask",
"x-vmw-nsx-example-response": "1. Export of current firewall configuration,\n{\n \"id\": \"export_task\",\n \"status\": \"running\",\n \"description\": \"Export of the current firewall configuration.\",\n \"exported_file\": \"fw_config_apr2020.zip\",\n \"failure_msg\": null,\n \"user\": \"admin\",\n \"start_time\": 1587491995996\n}\n\n2. Export of the draft,\n{\n \"id\": \"export_task\",\n \"status\": \"running\",\n \"description\": \"Export of the draft /infra/drafts/draft1\",\n \"exported_file\": \"draft1.zip\",\n \"failure_msg\": null,\n \"user\": \"admin\",\n \"start_time\": 1587491995996\n}\n",
"x-codegen-request-body-name": "ExportRequestParameter"
}
},
"/infra/spoofguard-profiles/{spoofguard-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Spoofguard Profiles"
],
"summary": "Get SpoofGuard profile",
"description": "API will return details of the SpoofGuard profile with given id. If the\nprofile does not exist, it will return 404.\n",
"operationId": "GetSpoofGuardProfile",
"parameters": [
{
"name": "spoofguard-profile-id",
"in": "path",
"description": "SpoofGuard profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpoofGuardProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/spoofguard-profiles/spoofguardprofile_1\n",
"x-vmw-nsx-module": "PolicySpoofGuard",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SpoofGuardProfile\",\n \"id\": \"spoofguardprofile_1\",\n \"display_name\": \"spoofguardprofile_1\",\n \"path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"parent_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"relative_path\": \"spoofguardprofile_1\",\n \"marked_for_delete\": false,\n \"address_binding_allowlist\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1539128784467,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539128784467,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Spoofguard Profiles"
],
"summary": "Create or replace SpoofGuard profile",
"description": "API will create or replace SpoofGuard profile.\n",
"operationId": "CreateOrUpdateSpoofGuardProfile",
"parameters": [
{
"name": "spoofguard-profile-id",
"in": "path",
"description": "SpoofGuard profile id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpoofGuardProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpoofGuardProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/spoofguard-profiles/spoofguardprofile_1\n {\n \"resource_type\": \"SpoofGuardProfile\",\n \"id\": \"spoofguardprofile_1\",\n \"display_name\": \"spoofguardprofile_1\",\n \"path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"parent_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"relative_path\": \"spoofguardprofile_1\",\n \"address_binding_allowlist\": true,\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "PolicySpoofGuard",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SpoofGuardProfile\",\n \"id\": \"spoofguardprofile_1\",\n \"display_name\": \"spoofguardprofile_1\",\n \"path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"parent_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"relative_path\": \"spoofguardprofile_1\",\n \"marked_for_delete\": false,\n \"address_binding_allowlist\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1539128784467,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129032044,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SpoofGuardProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Spoofguard Profiles"
],
"summary": "Delete SpoofGuard profile",
"description": "API will delete SpoofGuard profile with the given id.\n",
"operationId": "DeleteSpoofGuardProfile",
"parameters": [
{
"name": "spoofguard-profile-id",
"in": "path",
"description": "SpoofGuard profile id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/spoofguard-profiles/spoofguardprofile_1\n",
"x-vmw-nsx-module": "PolicySpoofGuard"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Spoofguard Profiles"
],
"summary": "Patch SpoofGuard profile",
"description": "Create a new SpoofGuard profile if the SpoofGuard profile with the given id\ndoes not exist. Otherwise, patch with the existing SpoofGuard profile.\n",
"operationId": "PatchSpoofGuardProfile",
"parameters": [
{
"name": "spoofguard-profile-id",
"in": "path",
"description": "SpoofGuard profile id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpoofGuardProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/spoofguard-profiles/spoofguardprofile_1\n {\n \"display_name\": \"SpoofGuardProfile\",\n \"description\": \"SpoofGuardProfile\",\n \"address_binding_allowlist\": true\n }\n",
"x-vmw-nsx-module": "PolicySpoofGuard",
"x-codegen-request-body-name": "SpoofGuardProfile"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings"
],
"summary": "Read DHCP static binding state",
"description": "Read DHCP static binding state",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadSegmentDhcpStaticBindingState",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-bindings/server1/state\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"details\": [\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"fe651e63-04bd-43a4-a8ec-45381a3b71b9\",\n \"state\": \"in_progress\",\n \"failure_message\": \"CCP Id:ab5958df-d98a-468e-a72b-d89dcdae5346, Message:State realization is in progress at the node.\"\n },\n {\n \"sub_system_type\": \"TransportNode\",\n \"sub_system_id\": \"ebe174ac-e4f1-4135-ba72-3dd2eb7099e3\",\n \"state\": \"in_sync\"\n }\n ],\n \"state\": \"in_progress\",\n \"failure_message\": \"The state realization is in progress at transport nodes.\"\n}\n"
}
},
"/infra/segments/{segment-id}/bep-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Bridge Endpoints",
"Statistics"
],
"summary": "Get Tier-1 segment bridge end point status using segment ID and profile path.",
"description": "Get detailed information on Tier-1 segment bridge end point status using segment ID and profile path.\n",
"operationId": "InfraSegmentBridgeEndpointStatus",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bridge_profile_path",
"in": "query",
"description": "Bridge profile path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BridgeEndpointStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "# TODO: change this sample request after api is tested\nGET https://<policy-mgr>/policy/api/v1/infra/segments/segment-1/bep-status?bridge_profile_path=/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{ # TODO: change this sample response after api is tested\n \"active_nodes\": [\n \"/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1\"\n ],\n \"last_update_timestamp\": 1457547568679,\n \"endpoint_id\": \"15269939-779a-4fa4-9a0a-792dbf9fac12\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "List Segment QoS Profile Binding Maps",
"description": "API will list all Segment QoS Profile Binding Maps in current segment id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListSegmentQoSBindings",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns/{l3vpn-id}/peer-config": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions",
"Tier-0 Gateways"
],
"summary": "Download L3Vpn Config for Remote Site",
"description": "Get the L3Vpn Configuration for the peer site. Peer config contains PSK;\nbe careful when sharing or storing it.\n- no enforcement point path specified: L3Vpn Peer Config will be evaluated on\neach enforcement point.\n- {enforcement_point_path}: L3Vpn Peer Config is evaluated only on the given\nenforcement point.\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/locale-services/\n<locale-service-id>/ipsec-vpn-services/default/sessions/L3VPN_<l3vpn-id>/peer-config\ninstead.\n",
"operationId": "ReadL3VpnPeerConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "l3vpn-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/l3vpns/pa-tokyo-pb-vpn/peer-config\n",
"x-vmw-nsx-module": "PolicyL3Vpn",
"x-vmw-nsx-example-response": "# Suggestive peer configuration for Policy L3Vpn\n#\n# L3Vpn path : /infra/tier-0s/vmc/locale-services/default/ipsec-vpn-services/default/sessions/L3VPN_pa-tokyo-pb-vpn\n# L3Vpn name : pa-tokyo-pb-vpn\n# L3Vpn description :\n# Tier-0 path : /infra/tier-0s/vmc\n\n\n#\n# Enforcement point path : /infra/deployment-zones/default/enforcement-points/nsxt\n# Enforcement point type : NSXT\n#\n# Suggestive peer configuration for IPSec VPN Connection\n#\n# IPSecVPNSession Id : aafeb845-e2fa-4c86-9f0e-43c5ed3ef707\n# IPSecVPNSession name : policy-session-PROVIDER.sarah1.pa-paris-rb-vpn\n# IPSecVPNSession description:\n# IPSecVPNSession enabled : true\n# IPSecVPNSession type : Route based VPN\n# Logical router Id : d58beabb-853c-473c-ad8d-34bd9c644692\n# Generated Time : Tue Apr 03 14:21:13 GMT 2018\n\n#\n# Internet Key Exchange Configuration [Phase 1]\n# Configure the IKE SA as outlined below\nIKE version : IKE_V2\nConnection initiation mode : INITIATOR\nAuthentication method : PSK\nPre shared key : 12345\nAuthentication algorithm : [SHA2_256]\nEncryption algorithm : [AES_128]\nSA life time : 86400\nNegotiation mode : Not applicable for ikev2\nDH group : [GROUP14]\n\n# IPsec_configuration [Phase 2]\n# Configure the IPsec SA as outlined below\nTransform Protocol : ESP\nAuthentication algorithm : []\nSa life time : 3600\nEncryption algorithm : [AES_GCM_128]\nEncapsulation mode : TUNNEL_MODE\nEnable perfect forward secrecy : true\nPerfect forward secrecy DH group: [GROUP14]\n\n# IPsec Dead Peer Detection (DPD) settings\nDPD enabled : true\nDPD probe interval : 60\n\n# Peer configuration\nPeer address : 88.88.72.22 # Peer gateway public IP.\nPeer id : 88.88.72.22\nPeer Subnet : 0.0.0.0/0\n\n\n# Local configuration\nLocal address : 44.44.44.46 # Local gateway public IP.\nLocal id : 99.33.33.33\nLocal Subnet : 0.0.0.0/0\n\n\n# Virtual Tunnel Interface\nPeer VTI address : 192.168.2.1\nLocal VTI address : 192.168.2.11\nTunnel Interface MTU : 1416 bytes\n\n#\n# BGP Configuration\n#\nBGP neighbour IP : 192.168.2.1\nBGP neighbour AS number : 2000\nBGP local IP : 192.168.2.11\nBGP local AS number : 65556\nBGP secret : PolicyRocks\nBGP hold down timer : 180\nBGP keep alive timer : 60\nBFD Status : false\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/arp-proxies?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"ARP Proxies"
],
"summary": "Get Tier-0 Address Resolution Protocol Proxies in CSV format",
"description": "Returns ARP proxy table for a tier-0 in CSV format\n",
"operationId": "GlobalInfraGetTier0GatewayArpProxiesInCsv",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-0s/pepsi/arp-proxies?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "TODO : smanikarnike\n"
}
},
"/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Status"
],
"summary": "Get L2VPN session detailed status under Tier-0",
"description": "- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.\n- an enforcement point path is specified: detailed status is evaluated only on the given\nenforcement point.\n- source=realtime: detailed tatus is fetched realtime from the enforcement point.\n- source=cached: cached detailed status is returned.\n",
"operationId": "GetTier0VpnL2VpnSessionStatus",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VPNSessionStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/l2vpn-services/default/sessions/stretched-pa-site/detailed-status\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/tls-inspection-action-profiles": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Tls Inspection",
"Tls Profiles"
],
"summary": "Get Tls profiles available.",
"description": "List all the Tls profiles available by requested resource_type.\n",
"operationId": "ListTlsProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tls-inspection-action-profiles\n",
"x-vmw-nsx-module": "PolicyTlsActionProfile",
"x-vmw-nsx-example-response": "{\n \"result_count\": 1,\n \"results\": [\n {\n \"tls_config_setting\": \"BALANCED\",\n \"invalid_cert_action\": \"ALLOW\",\n \"decryption_fail_action\": \"BYPASS\",\n \"crypto_enforcement\": \"ENFORCE\",\n \"client_min_tls_version\": \"TLS_V1_1\",\n \"client_max_tls_version\": \"TLS_V1_2\",\n \"server_min_tls_version\": \"TLS_V1_1\",\n \"server_max_tls_version\": \"TLS_V1_2\",\n \"client_cipher_suite\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_256_GCM_SHA384\",\n \"TLS_RSA_WITH_AES_256_CBC_SHA256\"\n ],\n \"server_cipher_suite\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_256_GCM_SHA384\",\n \"TLS_RSA_WITH_AES_256_CBC_SHA256\"\n ],\n \"proxy_trusted_ca_cert\": \"/infra/certificates/caCert1\",\n \"proxy_untrusted_ca_cert\": \"/infra/certificates/caCert2\",\n \"ocsp_must_staple\": false,\n \"resource_type\": \"TlsInspectionExternalProfile\",\n \"id\": \"external-balanced-profile\",\n \"display_name\": \"external-balanced-profile\",\n \"path\": \"/infra/tls-inspection-action-profiles/external-balanced-profile\",\n \"relative_path\": \"external-balanced-profile\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"bb236080-e49d-4475-9eb3-b749b075164a\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"trusted_ca_bundles\": [\n \"/infra/cabundles/default_trusted_public_ca_bundle\"\n ],\n \"crls\": [\n \"/infra/crls/nsx_default_public_crl\"\n ],\n \"idle_connection_timeout\": 5400,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1622225641015,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1622225641015,\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/redirection-policies": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Redirection Policies"
],
"summary": "List redirection policies for a domain",
"description": "List redirection policies for a domain",
"operationId": "ListRedirectionPolicies",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedirectionPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/redirection-policies\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n\"sort_ascending\": true,\n\"sort_by\": \"display_name\",\n\"result_count\": 1,\n\"results\":[{\n\"resource_type\": \"RedirectionPolicy\",\n\"description\": \"redirec-comon-map-1\",\n\"id\": \"redirec-comon-map-1\",\n\"display_name\": \"redirection-communication-map\",\n\"path\": \"/infra/domains/domain1/redirection-policies/redirec-comon-map-1\",\n\"relative_path\": \"redirection-communication-map-1000\",\n\"rules\": [\n ],\n\"redirect_to\": [\"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\"],\n\"_create_user\": \"admin\",\n\"_create_time\": 1513751042428,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1513856178337,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1\n } ]\n}\n"
}
},
"/global-infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"MAC Table"
],
"summary": "Get infra segment port MAC table in CSV",
"description": "Returns MAC table for a segment port\n",
"operationId": "GlobalInfraGetInfraSegmentPortMacTableInCsv",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/SegmentPortMacAddressCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWN_LINK_SWITCH/ports/default:d808cd01-b20b-485b-8e57-983a84fa7642/mac-table?format=csv&source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,mac_type\n00:0c:29:ce:0f:77,STATIC\n"
}
},
"/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Get IPSec VPN local endpoint list result",
"description": "Get paginated list of all IPSec VPN local endpoints\nfor a given ipsec vpn service under Tier-0.\n",
"operationId": "ListTier0VpnIPSecVpnLocalEndpoints",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpointListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default/local-endpoints\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"path\" : \"/infra/tier-0s/ext_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\": \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/infra/dns-security-profiles": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"DNS Security Profiles"
],
"summary": "List all DNS security profiles",
"description": "List all DNS security profiles",
"operationId": "ListDnsSecurityProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DnsSecurityProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dns-security-profiles\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"resource_type\" : \"DnsSecurityProfile\",\n \"id\" : \"default\",\n \"display_name\" : \"default-dns-profile\",\n \"path\" : \"/infra/dns-security-profiles/default\",\n \"parent_path\" : \"/infra/dns-security-profiles\",\n \"relative_path\" : \"default\",\n \"display_name\" : \"default-dns-profile\",\n \"ttl\" : 10000,\n \"_create_user\" : \"admin\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/cluster/restore?action=start": {
"post": {
"tags": [
"System Administration",
"Lifecycle Management",
"Backup Restore Management",
"Restore"
],
"summary": "Initiate a restore operation",
"description": "Start the restore of an NSX cluster, from some previously\nbacked-up configuration. This operation is only valid\nwhen a GET cluster/restore/status returns a status with value NOT_STARTED.\nOtherwise, a 409 response is returned.\n",
"operationId": "InitiateClusterRestore",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateClusterRestoreRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterRestoreStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterRestoreStatus"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/cluster/restore?action=start\n{\n \"node_id\": \"2128af2d-d763-4a27-80e0-4933af7e4824\",\n \"timestamp\" : 1435298084391\n}\n",
"x-vmw-nsx-module": "ClusterRestore",
"x-vmw-nsx-example-response": "{\n \"id\": \"86e81e05-bc3c-4216-a0a2-3bf46ece68a3\",\n \"backup_timestamp\": 1435298084391,\n \"restore_start_time\": 1483463180963,\n \"restore_end_time\": null,\n \"step\": {\n \"step_number\": 1,\n \"value\": \"RESTORE_INITIATED\",\n \"description\": \"Starting cluster restore\"\n \"status\": {\n \"value\": \"RUNNING\",\n \"description\": \"The operation is currently running\"\n }\n },\n \"status\": {\n \"value\": \"RUNNING\",\n \"description\": \"The operation is currently running\"\n }\n \"total_steps\": 11,\n \"endpoints\": [\n {\n action: POST, href: '/cluster/restore?action=suspend', rel: \"self\"\n },\n {\n action: POST, href: '/cluster/restore?action=cancel', rel: \"self\"\n }\n ],\n \"instructions\": []\n}\n",
"x-codegen-request-body-name": "InitiateClusterRestoreRequest"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"DAD State"
],
"summary": "Get DAD status by interface",
"description": "Get tier-1 interface DAD state information.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1InterfaceDADState",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceDADState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/pepsi/locale-services/default/interfaces/to_internet/dad-state?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_path\": \"/infra/tier-1s/pepsi/locale-services/default/interfaces/to_internet\",\n \"dad_statuses\": [\n {\n \"ip_address\": \"2001::1\",\n \"status\": \"ASSIGNED\",\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-point/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd/edge-nodes/940f1f4b-0317-45d4-84e2-b8c2394e7405\"\n ]\n }\n ]\n}\n"
}
},
"/alb/controller-nodes/user-credential": {
"put": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Alb User Credential"
],
"summary": "Update admin user or service user object password in ALB controller.",
"description": "Use this API to update admin user password or service user object password in ALB controller.\nThis API is for VCF deployments only.\n",
"operationId": "UpdateAlbUserCredentialObject",
"parameters": [
{
"name": "running_config",
"in": "query",
"description": "Update Advanced Load Balancer Controller runtime config as well",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerUserCredential"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerUserCredentialResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/alb/controller-nodes/user-credential\n{\n \"user_credential_type\": \"VCENTER_SERVICE_USER_CREDENTIAL\",\n \"password\": \"Pass@1234\"\n \"username\": \"vc-d6c00477-bd33-40fd-9e79-c6b4f0708b0a-service-user\",\n \"clustering_id\": \"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n}\n",
"x-vmw-nsx-module": "PolicyALBControllerOnBoarding",
"x-vmw-nsx-example-response": "{\n \"user_credential_type\": \"VCENTER_SERVICE_USER_CREDENTIAL\",\n \"username\": \"vc-d6c00477-bd33-40fd-9e79-c6b4f0708b0a-service-user\"\n}\n",
"x-codegen-request-body-name": "ALBControllerUserCredential"
},
"post": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Alb User Credential"
],
"summary": "Create service user object credential in ALB controller clutser",
"description": "Use this API to create service user object credential in ALB controller clutser.\nThis API is for VCF deployments only.\n",
"operationId": "CreateAlbUserCredentialObject",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerUserCredential"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerUserCredentialResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/alb/controller-nodes/user-credential\n{\n \"user_credential_type\": \"VCENTER_SERVICE_USER_CREDENTIAL\",\n \"password\": \"Pass@123\",\n \"username\": \"vc-d6c00477-bd33-40fd-9e79-c6b4f0708b0a-service-user\",\n \"clustering_id\": \"e8abab64-774e-48fa-bd5c-41df7aefdb88\"\n}\n",
"x-vmw-nsx-module": "PolicyALBControllerOnBoarding",
"x-vmw-nsx-example-response": "{\n \"user_credential_type\": \"VCENTER_SERVICE_USER_CREDENTIAL\",\n \"username\": \"vc-d6c00477-bd33-40fd-9e79-c6b4f0708b0a-service-user\"\n}\n",
"x-codegen-request-body-name": "ALBControllerUserCredential"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/igmp-memberships?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Multicast"
],
"summary": "Get IGMP Memberships in CSV format",
"description": "Get Igmp Memberships in CSV format.\n",
"operationId": "GetPolicyIgmpMembershipsInCsvFormat",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/IgmpMembershipsInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-0s//locale-services//multicast/igmp-memberships?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "transport_node,interface,source_address,group,no_of_sources,igmp_version,uptime\n\"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a96e2790-51f7-11ea-aedf-005056a370d4\",uplink-278,40.40.40.1,224.0.1.40,1,2,11:55:01\n\"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a96e2790-51f7-11ea-aedf-005056a370d4\",downlink-279,169.254.0.2,239.101.101.101,1,2,11:55:01\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/associated-kubernetes-clusters": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get associated kubernetes clusters for given group",
"description": "Get list of clusters associated to this Group. This API is applicable for Groups\ncontaining kubernetes resources. For Groups containing other member types an empty list is returned.\n",
"operationId": "GetGroupAssociatedKubernetesClusters",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupAssociatedKubernetesClusterListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/associated-kubernetes-clusters\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"clusters\": [\n {\n \"external_id\": \"6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"tenant1\"\n },\n {\n \"external_id\": \"77r43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"tenant2\"\n }\n ]\n }\n ],\n \"result_count\": 2,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "List Port Discovery Profile Binding Maps",
"description": "API will list all Port Discovery Profile Binding Maps in current port id.\n",
"operationId": "GlobalInfraListPortDiscoveryBindings",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Revise the positioning of rule",
"description": "This is used to re-order a rule within a security policy.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReviseSecurityRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/emergency-section/rules/ce-1?action=revise&anchor_path=/infra/domains/vmc/security-policies/emergency-section/rules/ce-2&operation=insert_after\n{\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc_domain/security-policies/emergency-section/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc_domain/security-policies/emergency-section\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc_domain/groups/webgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc_domain/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/AD_Server\",\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "Rule"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments"
],
"summary": "Get downlink port Address Resolution Protocol Proxies for tier-1 segment",
"description": "Returns ARP proxy table for downlink port on connected to the segment\n",
"operationId": "GlobalInfraGetDownlinkPortArpProxiesForTier1Segment",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s//segments/test-segment/arp-proxy\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Read an IpAddressPoolSubnet",
"description": "Read IpAddressPoolSubnet with given Id.\n",
"operationId": "ReadIpAddressPoolSubnet",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPoolSubnet"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IpAddressPoolBlockSubnet\",\n \"id\": \"Subnet-1\",\n \"display_name\": \"Subnet-1\",\n \"path\": \"/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\",\n \"parent_path\": \"/infra/ip-pools/IpPool-Tenant-1/ip-subnets\",\n \"relative_path\": \"Subnet-1\",\n \"size\": \"16\",\n \"ip_block_path\":\"/infra/ip-blocks/Finance-block\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Create a new IP Subnet",
"description": "Creates a new IpAddressPoolSubnet with the specified ID if it does not\nalready exist. If a IpAddressPoolSubnet of the given ID already exists,\nIpAddressPoolSubnet will be updated. This is a full replace.\n",
"operationId": "CreateOrReplaceIpAddressPoolSubnet",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPoolSubnet"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPoolSubnet"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\n{\n \"display_name\": \"Subnet-1\",\n \"description\": \"Subnet-1 Description\",\n \"resource_type\": \"IpAddressPoolBlockSubnet\",\n \"size\": \"16\",\n \"ip_block_path\":\"/infra/ip-blocks/Finance-block\"\n}\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IpAddressPoolBlockSubnet\",\n \"id\": \"Subnet-1\",\n \"display_name\": \"Subnet-1\",\n \"path\": \"/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\",\n \"parent_path\": \"/infra/ip-pools/IpPool-Tenant-1\",\n \"relative_path\": \"Subnet-1\",\n \"size\": \"16\",\n \"ip_block_path\":\"/infra/ip-blocks/Finance-block\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "IpAddressPoolSubnet"
},
"delete": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Delete an IpAddressPoolSubnet",
"description": "Delete the IpAddressPoolSubnet with the given id.\n",
"operationId": "DeleteIpAddressPoolSubnet",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ignore_ip_allocations",
"in": "query",
"description": "Flag to specify whether to ignore ip allocations.\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/IpPool-Tenant-1/ip-subnets/Subnet-1\n",
"x-vmw-nsx-module": "PolicyIpam"
},
"patch": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Create a new IP Subnet",
"description": "Creates a new IpAddressPoolSubnet with the specified ID if it does not\nalready exist. If a IpAddressPoolSubnet of the given ID already exists,\nIpAddressPoolSubnet will be updated. This is a full replace.\n",
"operationId": "CreateOrPatchIpAddressPoolSubnet",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPoolSubnet"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "1. PATCH https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\n{\n \"display_name\": \"Subnet-1\",\n \"description\": \"Subnet-1 Description\",\n \"resource_type\": \"IpAddressPoolBlockSubnet\",\n \"size\": \"16\",\n \"ip_block_path\":\"/infra/ip-blocks/Finance-block\"\n}\n\n2. PATCH https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\n{\n \"display_name\": \"Subnet-1\",\n \"description\": \"Subnet-1 Description\",\n \"resource_type\": \"IpAddressPoolStaticSubnet\",\n \"allocation_ranges\": [\n {\n \"start\":\"192.168.0.1\",\n \"end\":\"192.168.0.14\"\n }\n ],\n \"cidr\":\"192.168.0.0/28\"\n}\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-codegen-request-body-name": "IpAddressPoolSubnet"
}
},
"/infra/evpn-tenant-configs/{config-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"EVPN Tenant Configuration"
],
"summary": "Read Evpn Tenant Configuration",
"description": "Read Evpn Tenant Configuration.\n",
"operationId": "ReadEvpnTenantConfig",
"parameters": [
{
"name": "config-id",
"in": "path",
"description": "config id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTenantConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET /infra/evpn-tenant-configs/config2\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"mappings\": [{\n \"vlans\": \"13\",\n \"vnis\": \"86015\"\n },{\n \"vlans\": \"40-50\",\n \"vnis\": \"86000-86010\"\n },{\n \"vlans\": \"100-150\",\n \"vnis\": \"86050-86100\"\n }],\n \"transport_zone_path\": \"/infra/sites/default/enforcement-points/default/transport-zones/dab3561c-d1ee-41db-ad26-67c5bd0f2414\",\n \"vni_pool_path\": \"/infra/vni-pools/vnipool\",\n \"resource_type\": \"EvpnTenantConfig\",\n \"id\": \"config\",\n \"display_name\": \"config\",\n \"path\": \"/infra/evpn-tenant-configs/config\",\n \"relative_path\": \"config\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"bb0810f1-8a79-42ac-97a0-5c6383fbe349\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1588795958005,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1588795958014,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"EVPN Tenant Configuration"
],
"summary": "Create or Update Evpn Tenant Configuration",
"description": "Create or update Evpn Tenant configuration.\n",
"operationId": "CreateOrUpdateEvpnTenantConfig",
"parameters": [
{
"name": "config-id",
"in": "path",
"description": "Evpn Tenant config id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTenantConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTenantConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT /infra/evpn-tenant-configs/config\n{\n \"mappings\": [{\n \"vlans\": \"13\",\n \"vnis\": \"86015\"\n },{\n \"vlans\": \"40-50\",\n \"vnis\": \"86000-86010\"\n },{\n \"vlans\": \"100-150\",\n \"vnis\": \"86050-86100\"\n }],\n \"transport_zone_path\": \"/infra/sites/default/enforcement-points/default/transport-zones/dab3561c-d1ee-41db-ad26-67c5bd0f2414\",\n \"vni_pool_path\": \"/infra/vni-pools/vnipool\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-codegen-request-body-name": "EvpnTenantConfig"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"EVPN Setting",
"EVPN Tunnel Endpoints"
],
"summary": "Delete evpn tunnel endpoint configuration",
"description": "Delete evpn tunnel endpoint configuration.",
"operationId": "DeleteEvpnTenantConfig",
"parameters": [
{
"name": "config-id",
"in": "path",
"description": "tier0 id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE /infra/evpn-tenant-configs/\n",
"x-vmw-nsx-module": "PolicyConnectivity"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"EVPN Tenant Configuration"
],
"summary": "Create or Update Evpn Tenant Configuration",
"description": "Create a global evpn tenant configuration if it is not already present,\notherwise update the evpn tenant configuration.\n",
"operationId": "PatchEvpnTenantConfig",
"parameters": [
{
"name": "config-id",
"in": "path",
"description": "Evpn Tenant config id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTenantConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH /infra/evpn-tenant-configs/config\n{\n \"mappings\": [{\n \"vlans\": \"13\",\n \"vnis\": \"86015\"\n },{\n \"vlans\": \"40-50\",\n \"vnis\": \"86000-86010\"\n },{\n \"vlans\": \"100-150\",\n \"vnis\": \"86050-86100\"\n }],\n \"transport_zone_path\": \"/infra/sites/default/enforcement-points/default/transport-zones/dab3561c-d1ee-41db-ad26-67c5bd0f2414\",\n \"vni_pool_path\": \"/infra/vni-pools/vnipool\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-codegen-request-body-name": "EvpnTenantConfig"
}
},
"/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"ARP Proxies"
],
"summary": "Get Tier-1 Address Resolution Protocol Proxies",
"description": "Get Tier-1 Address Resolution Protocol Proxies.\n
\nThis API is deprecated. Please use /infra/tier-1s/<tier-1-id>/arp-proxies\nReturns ARP proxy table for a tier-1\n",
"operationId": "GlobalInfraGetTier1ArpProxies",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s/pepsi/locale-services/1-policyconnectivity-1340/arp-proxies\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"22\",\n \"arp_proxy_ip\" : \"10.22.2.42\"\n },\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Statistics"
],
"summary": "Get IPSec VPN session statistics under Tier-0",
"description": "- no enforcement point path specified: statistics are evaluated on each enforcement point.\n- an enforcement point path is specified: statistics are evaluated only on the given\nenforcement point.\n- source=realtime: statistics are fetched realtime from the enforcement point.\n- source=cached: cached statistics from enforcement point are returned.\n\n
\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/\nsessions/<session-id>/statisticsinstead.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier0IPSecVpnSessionStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateIPSecVpnSessionStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1/statistics\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
},
"post": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Statistics"
],
"summary": "Reset the statistics of the given VPN session",
"description": "Resets the statistics of the given VPN session.\nSince source of data is enforcement point, data is\nreset there.\n\n
\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/\nsessions/<session-id>/statistics instead.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraResetTier0IPSecVpnSessionStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action on statistics",
"required": true,
"schema": {
"type": "string",
"enum": [
"reset"
]
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1/statistics?action=reset\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "List all DHCP static bindings",
"description": "Paginated list of all DHCP static binding instances\n",
"operationId": "ListSegmentDhcpStaticBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"address1\",\n \"path\": \"/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/tier-1s/mgw/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595467058,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/l7-access-profiles/{l7-access-profile-id}": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "Get L7 Access Profile",
"description": "API will get L7 Access Profile",
"operationId": "GetL7AccessProfile",
"parameters": [
{
"name": "l7-access-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/l7-access-profiles/profile-1\n",
"x-vmw-nsx-module": "L7AccessProfile",
"x-vmw-nsx-example-response": "{\n \"l7_access_entries\": [\n {\n \"sequence_number\": 100,\n \"attributes\": [\n {\n \"key\": \"APP_ID\",\n \"value\": [\n \"SSL\"\n ],\n \"datatype\": \"STRING\",\n \"sub_attributes\": [\n {\n \"key\": \"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\": \"STRING\"\n },\n {\n \"key\": \"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\": \"STRING\"\n }\n ],\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_0\",\n \"display_name\": \"entry_0\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_0\",\n \"relative_path\": \"entry_0\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"realization_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431167,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431167,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 101,\n \"attributes\": [\n {\n \"key\": \"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": false,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_1\",\n \"display_name\": \"entry_1\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_1\",\n \"relative_path\": \"entry_1\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"realization_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431168,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431168,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 102,\n \"attributes\": [\n {\n \"key\": \"URL_CATEGORY\",\n \"value\": [\n \"Auctions\",\n \"Abused Drugs\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_2\",\n \"display_name\": \"entry_2\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_2\",\n \"relative_path\": \"entry_2\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"realization_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431169,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431169,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 103,\n \"attributes\": [\n {\n \"key\": \"URL_REPUTATION\",\n \"value\": [\n \"Suspicious\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT_WITH_RESPONSE\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_3\",\n \"display_name\": \"entry_3\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_3\",\n \"relative_path\": \"entry_3\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"realization_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431171,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431171,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"user_response_message\": \"\",\n \"default_action\": \"REJECT\",\n \"default_action_logged\": false,\n \"resource_type\": \"L7AccessProfile\",\n \"id\": \"profile-1\",\n \"display_name\": \"profile-1\",\n \"description\": \"Test Policy L7 Access Profile\",\n \"path\": \"/infra/l7-access-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"realization_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431163,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431163,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "Update L7 Access Profile",
"description": "API will update L7 Access Profile",
"operationId": "CreateOrUpdateL7AccessProfile",
"parameters": [
{
"name": "l7-access-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/l7-access-profiles/profile-1\n{\n \"resource_type\": \"L7AccessProfile\",\n \"display_name\": \"profile-1\",\n \"description\":\"Test Policy L7 Access Profile\",\n \"l7_access_entries\": [\n {\n \"display_name\": \"entry_0\",\n \"sequence_number\": 100,\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\":[\n \"SSL\"\n ],\n \"datatype\":\"STRING\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\":\"STRING\"\n }\n ],\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\" : true\n },\n {\n \"display_name\": \"entry_1\",\n \"sequence_number\": 101,\n \"attributes\":[\n {\n \"key\":\"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"CUSTOM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\" : false\n },\n {\n \"display_name\": \"entry_2\",\n \"sequence_number\": 102,\n \"attributes\":[\n {\n \"key\":\"URL_CATEGORY\",\n \"value\": [\n \"Auctions\",\n \"Abused Drugs\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT\",\n \"logged\" : true\n },\n {\n \"display_name\": \"entry_3\",\n \"sequence_number\": 103,\n \"attributes\":[\n {\n \"key\":\"URL_REPUTATION\",\n \"value\": [\n \"Suspicious\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT_WITH_RESPONSE\",\n \"logged\" : true\n }\n ],\n \"default_action\": \"REJECT\"\n}\n",
"x-vmw-nsx-module": "L7AccessProfile",
"x-vmw-nsx-example-response": "{\n \"l7_access_entries\": [\n {\n \"sequence_number\": 100,\n \"attributes\": [\n {\n \"key\": \"APP_ID\",\n \"value\": [\n \"SSL\"\n ],\n \"datatype\": \"STRING\",\n \"sub_attributes\": [\n {\n \"key\": \"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\": \"STRING\"\n },\n {\n \"key\": \"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\": \"STRING\"\n }\n ],\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_0\",\n \"display_name\": \"entry_0\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_0\",\n \"relative_path\": \"entry_0\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"realization_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431167,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431167,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 101,\n \"attributes\": [\n {\n \"key\": \"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": false,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_1\",\n \"display_name\": \"entry_1\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_1\",\n \"relative_path\": \"entry_1\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"realization_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431168,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431168,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 102,\n \"attributes\": [\n {\n \"key\": \"URL_CATEGORY\",\n \"value\": [\n \"Auctions\",\n \"Abused Drugs\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_2\",\n \"display_name\": \"entry_2\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_2\",\n \"relative_path\": \"entry_2\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"realization_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431169,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431169,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 103,\n \"attributes\": [\n {\n \"key\": \"URL_REPUTATION\",\n \"value\": [\n \"Suspicious\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT_WITH_RESPONSE\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_3\",\n \"display_name\": \"entry_3\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_3\",\n \"relative_path\": \"entry_3\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"realization_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431171,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431171,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"user_response_message\": \"\",\n \"default_action\": \"REJECT\",\n \"default_action_logged\": false,\n \"resource_type\": \"L7AccessProfile\",\n \"id\": \"profile-1\",\n \"display_name\": \"profile-1\",\n \"description\": \"Test Policy L7 Access Profile\",\n \"path\": \"/infra/l7-access-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"realization_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431163,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431163,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "L7AccessProfile"
},
"delete": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "Delete L7 Access Profile",
"description": "API will delete L7 Access Profile",
"operationId": "DeleteL7AccessProfile",
"parameters": [
{
"name": "l7-access-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/l7-access-profiles/profile-1\n",
"x-vmw-nsx-module": "L7AccessProfile"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "Create or update L7 Access Profile",
"description": "API will create/update L7 Access Profile",
"operationId": "PatchL7AccessProfile",
"parameters": [
{
"name": "l7-access-profile-id",
"in": "path",
"description": "L7 Access Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/l7-access-profiles/profile-1\n{\n \"resource_type\": \"L7AccessProfile\",\n \"display_name\": \"profile-1\",\n \"description\":\"Test Policy L7 Access Profile\",\n \"l7_access_entries\": [\n {\n \"display_name\": \"entry_0\",\n \"sequence_number\": 100,\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\":[\n \"SSL\"\n ],\n \"datatype\":\"STRING\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\":\"STRING\"\n }\n ],\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\" : true\n },\n {\n \"display_name\": \"entry_1\",\n \"sequence_number\": 101,\n \"attributes\":[\n {\n \"key\":\"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"CUSTOM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\" : false\n },\n {\n \"display_name\": \"entry_2\",\n \"sequence_number\": 102,\n \"attributes\":[\n {\n \"key\":\"URL_CATEGORY\",\n \"value\": [\n \"Auctions\",\n \"Abused Drugs\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT\",\n \"logged\" : true\n },\n {\n \"display_name\": \"entry_3\",\n \"sequence_number\": 103,\n \"attributes\":[\n {\n \"key\":\"URL_REPUTATION\",\n \"value\": [\n \"Suspicious\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT_WITH_RESPONSE\",\n \"logged\" : true\n }\n ],\n \"default_action\": \"REJECT\"\n}\n",
"x-vmw-nsx-module": "L7AccessProfile",
"x-vmw-nsx-example-response": "{\n \"l7_access_entries\": [\n {\n \"sequence_number\": 100,\n \"attributes\": [\n {\n \"key\": \"APP_ID\",\n \"value\": [\n \"SSL\"\n ],\n \"datatype\": \"STRING\",\n \"sub_attributes\": [\n {\n \"key\": \"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\": \"STRING\"\n },\n {\n \"key\": \"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\": \"STRING\"\n }\n ],\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_0\",\n \"display_name\": \"entry_0\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_0\",\n \"relative_path\": \"entry_0\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"realization_id\": \"6403f261-02fd-42ec-ac1f-4f6fb59f42a6\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431167,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431167,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 101,\n \"attributes\": [\n {\n \"key\": \"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\": false,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_1\",\n \"display_name\": \"entry_1\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_1\",\n \"relative_path\": \"entry_1\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"realization_id\": \"f098b0c9-65ba-42ae-8798-19a4f4515447\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431168,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431168,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 102,\n \"attributes\": [\n {\n \"key\": \"URL_CATEGORY\",\n \"value\": [\n \"Auctions\",\n \"Abused Drugs\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_2\",\n \"display_name\": \"entry_2\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_2\",\n \"relative_path\": \"entry_2\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"realization_id\": \"7653be14-abe3-49d6-92bb-3f68303c6049\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431169,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431169,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"sequence_number\": 103,\n \"attributes\": [\n {\n \"key\": \"URL_REPUTATION\",\n \"value\": [\n \"Suspicious\"\n ],\n \"datatype\": \"STRING\",\n \"attribute_source\": \"SYSTEM\"\n }\n ],\n \"action\": \"REJECT_WITH_RESPONSE\",\n \"logged\": true,\n \"disabled\": false,\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry_3\",\n \"display_name\": \"entry_3\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry_3\",\n \"relative_path\": \"entry_3\",\n \"parent_path\": \"/infra/l7-access-profiles/profile-1\",\n \"unique_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"realization_id\": \"e099255b-ce22-4dd4-9e4c-73520ab54870\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431171,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431171,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"user_response_message\": \"\",\n \"default_action\": \"REJECT\",\n \"default_action_logged\": false,\n \"resource_type\": \"L7AccessProfile\",\n \"id\": \"profile-1\",\n \"display_name\": \"profile-1\",\n \"description\": \"Test Policy L7 Access Profile\",\n \"path\": \"/infra/l7-access-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"realization_id\": \"ec0e9217-56a5-443c-997e-f73a75e0e2db\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1631900431163,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1631900431163,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "L7AccessProfile"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"EVPN Setting",
"EVPN Tunnel Endpoints"
],
"summary": "Read evpn tunnel endpoint configuration",
"description": "Read evpn tunnel endpoint configuration.\n",
"operationId": "ReadEvpnTunnelEndpointConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "tier0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"description": "locale services id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-endpoint-id",
"in": "path",
"description": "tunnel endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTunnelEndpointConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/test/locale-services/default/evpn-tunnel-endpoints/t1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"edge_path\": \"/infra/vni-pools/pool2\",\n \"local_addresses\": [\n \"1.1.1.1\"\n ],\n \"mtu\": 65,\n \"resource_type\": \"EvpnTunnelEndpointConfig\",\n \"id\": \"t1\",\n \"display_name\": \"t1\",\n \"path\": \"/infra/tier-0s/test/locale-services/default/evpn-tunnel-endpoints/t1\",\n \"relative_path\": \"t1\",\n \"parent_path\": \"/infra/tier-0s/test/locale-services/default\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1558118034309,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1558723709792,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"EVPN Setting",
"EVPN Tunnel Endpoints"
],
"summary": "Create or Update evpn tunnel endpoint configuration",
"description": "Create or update evpn tunnel endpoint configuration.\n",
"operationId": "CreateOrUpdateEvpnTunnelEndpointConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "tier0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"description": "locale services id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-endpoint-id",
"in": "path",
"description": "tunnel endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTunnelEndpointConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTunnelEndpointConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/test/locale-services/default/evpn-tunnel-endpoints/t1\n{\n\n \"edge_path\": \"/infra/vni-pools/pool2\",\n \"local_addresses\": [\"1.1.1.1\"],\n \"mtu\": 65\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"edge_path\": \"/infra/vni-pools/pool2\",\n \"local_addresses\": [\n \"1.1.1.1\"\n ],\n \"mtu\": 65,\n \"resource_type\": \"EvpnTunnelEndpointConfig\",\n \"id\": \"t1\",\n \"display_name\": \"t1\",\n \"path\": \"/infra/tier-0s/test/locale-services/default/evpn-tunnel-endpoints/t1\",\n \"relative_path\": \"t1\",\n \"parent_path\": \"/infra/tier-0s/test/locale-services/default\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1558118034309,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1558723709792,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "EvpnTunnelEndpointConfig"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"EVPN Setting",
"EVPN Tunnel Endpoints"
],
"summary": "Delete evpn tunnel endpoint configuration",
"description": "Delete evpn tunnel endpoint configuration.",
"operationId": "DeleteEvpnTunnelEndpointConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "tier0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"description": "locale services id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-endpoint-id",
"in": "path",
"description": "tunnel endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s//locale-services//evpn-tunnel-endpoints/\n",
"x-vmw-nsx-module": "PolicyConnectivity"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"EVPN Setting",
"EVPN Tunnel Endpoints"
],
"summary": "Create or Update evpn tunnel endpoint configuration",
"description": "Create a evpn tunnel endpoint config if the tunnel-endpoint-id is not already present,\notherwise update the tunnel endpoint configuration.\n",
"operationId": "PatchEvpnTunnelEndpointConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "tier0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"description": "locale services id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-endpoint-id",
"in": "path",
"description": "tunnel endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTunnelEndpointConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/test/locale-services/default/evpn-tunnel-endpoints/t1\n {\n \"edge_path\": \"/infra/vni-pools/pool2\",\n \"local_addresses\": [\"1.1.1.1\"],\n \"mtu\": 65\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-codegen-request-body-name": "EvpnTunnelEndpointConfig"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"MAC Table"
],
"summary": "Get Tier-1 segment MAC table",
"description": "Returns MAC table for a segment\n",
"operationId": "GlobalInfraGetTier1SegmentMacTable",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMacAddressListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://policy-mgr/policy/api/v1/infra/tier-1s/pepsi/segments/TIER0_DOWN_LINK_SWITCH/mac-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"last_update_timestamp\": 1591767144064,\n \"results\": [\n {\n \"mac_address\": \"00:0c:29:ce:0f:77\",\n \"tep_ip\": \"100.100.100.3\",\n \"tep_mac_address\": \"00:50:56:6a:af:ce\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/pcaps/{id}": {
"delete": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "Delete the IDS Pcap File",
"description": "Delete IDS Pcap file entry from corfu and from file system.\nCurrently this is a node specific API and it will delete the PCAP\nmetadata and file for the specific node only. If PCAP file is not\npresent on the specific node, validation error will be thrown.\n",
"operationId": "DeleteIdsPcapFile",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of IdsPcapFileMetadata",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/pcaps/ids_lm_pcap_1712465586573\n",
"x-vmw-nsx-module": "PolicyIDS"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/constraints/{constraint-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Constraints"
],
"summary": "Read tenant Constraint.",
"description": "Read tenant constraint.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadTenantConstraint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "constraint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Constraint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>policy/api/v1/infra/constraints/related-attribute-constraint\n",
"x-vmw-nsx-module": "PolicyConstraints",
"x-vmw-nsx-example-response": "{\n \"constraint_expressions\": [{\n \"resource_type\": \"RelatedAttributeConditionalExpression\",\n \"condition\": {\n \"value_constraint\": {\n \"resource_type\": \"ValueConstraintExpression\",\n \"values\": [\n \"/infra/services/HTTP\",\n \"/infra/services/HTTPS\"\n ],\n \"operator\": \"INCLUDES\",\n \"_protection\": \"NOT_PROTECTED\"\n },\n \"rhs_value\": [\n \"/infra/domains/mgw/groups/VCENTER\"\n ],\n \"operator\": \"INCLUDES\"\n },\n \"related_attribute\": {\n \"attribute\": \"destinationGroups\"\n },\n \"_protection\": \"NOT_PROTECTED\"\n }],\n \"targets\": [{\n \"target_resource_type\": \"CommunicationEntry\",\n \"attribute\": \"services\",\n \"path_prefix\": \"/infra/domains/amar/edge-communication-maps/default/communication-entries/\"\n }],\n \"_protection\": \"NOT_PROTECTED\"\n}\n"
},
"put": {
"tags": [
"Policy",
"Infra",
"Constraints"
],
"summary": "Create or update tenant Constraint",
"description": "Create tenant constraint if it does not exist,\notherwise replace the existing constraint.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrReplaceTenantConstraint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "constraint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Constraint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Constraint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>policy/api/v1/infra/constraints/value-constraint\n {\n \"target\":{\n \"target_resource_type\":\"CommunicationEntry\",\n \"attribute\":\"services\",\n \"path_prefix\":\"/infra/domains/{{DOMAIN}}/edge-communication-maps/default/communication-entries/\"\n },\n \"constraint_expression\":{\n \"resource_type\":\"RelatedAttributeConditionalExpression\",\n \"related_attribute\":{\n \"attribute\":\"destinationGroups\"\n },\n \"condition\":{\n \"operator\":\"INCLUDES\",\n \"rhs_value\":[\"/infra/domains/mgw/groups/VCENTER\"],\n \"value_constraint\":{\n \"resource_type\": \"ValueConstraintExpression\",\n \"operator\":\"INCLUDES\",\n \"values\":[\"/infra/services/HTTP\", \"/infra/services/HTTPS\"]\n }\n }\n }\n }\n",
"x-vmw-nsx-module": "PolicyConstraints",
"x-vmw-nsx-example-response": "{\n \"constraint_expressions\": [{\n \"resource_type\": \"RelatedAttributeConditionalExpression\",\n \"condition\": {\n \"value_constraint\": {\n \"resource_type\": \"ValueConstraintExpression\",\n \"values\": [\n \"/infra/services/HTTP\",\n \"/infra/services/HTTPS\"\n ],\n \"operator\": \"INCLUDES\",\n \"_protection\": \"NOT_PROTECTED\"\n },\n \"rhs_value\": [\n \"/infra/domains/mgw/groups/VCENTER\"\n ],\n \"operator\": \"INCLUDES\"\n },\n \"related_attribute\": {\n \"attribute\": \"destinationGroups\"\n },\n \"_protection\": \"NOT_PROTECTED\"\n }],\n \"targets\": [{\n \"target_resource_type\": \"CommunicationEntry\",\n \"attribute\": \"services\",\n \"path_prefix\": \"/infra/domains/amar/edge-communication-maps/default/communication-entries/\"\n }],\n \"_protection\": \"NOT_PROTECTED\"\n}\n",
"x-codegen-request-body-name": "Constraint"
},
"delete": {
"tags": [
"Policy",
"Infra",
"Constraints"
],
"summary": "Delete tenant Constraint.",
"description": "Delete tenant constraint.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTenantConstraint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "constraint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>policy/api/v1/infra/constraints/related-attribute-constraint\n",
"x-vmw-nsx-module": "PolicyConstraints"
},
"patch": {
"tags": [
"Policy",
"Infra",
"Constraints"
],
"summary": "Create or update tenant Constraint",
"description": "Create tenant constraint if not exists, otherwise update the existing constraint.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchTenantConstraint",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "constraint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Constraint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "1. PATCH https://<policy-mgr>policy/api/v1/infra/constraints/related-attribute-constraint\n{\n \"targets\":[{\n \"target_resource_type\":\"CommunicationEntry\",\n \"attribute\":\"services\",\n \"path_prefix\": \"/infra/domains/{{DOMAIN}}/edge-communication-maps/default/communication-entries/\"\n }],\n \"constraint_expressions\": [{\n \"resource_type\": \"RelatedAttributeConditionalExpression\",\n \"related_attribute\":{\n \"attribute\":\"destinationGroups\"\n },\n \"condition\" : {\n \"operator\":\"INCLUDES\",\n \"rhs_value\": [\"/infra/domains/mgw/groups/VCENTER\"],\n \"value_constraint\": {\n \"resource_type\": \"ValueConstraintExpression\",\n \"operator\":\"INCLUDES\",\n \"values\":[\"/infra/services/HTTP\", \"/infra/services/HTTPS\"]\n }\n }\n }]\n}\n\n2. PATCH https://<policy-mgr>policy/api/v1/infra/constraints/sanity\n{\n \"targets\": [{\n \"target_resource_type\": \"DnsForwarderZone\",\n \"attribute\": \"upstreamServers\",\n \"path_prefix\": \"/infra/dns-forwarder-zones/\"\n }],\n \"constraint_expressions\": [{\n \"resource_type\": \"FieldSanityConstraintExpression\",\n \"operator\": \"OR\",\n \"checks\": [\"ALL_PUBLIC_IPS\", \"ALL_PRIVATE_IPS\"]\n }]\n}\n\n3. PATCH https://<policy-mgr>policy/api/v1/orgs/default/projects/project-1/infra/constraints/vpc-1-quota\n{\n \"display_name\": \"Vpc-1 Quota\",\n \"constraint_expressions\": [{\n \"resource_type\": \"EntityInstanceCountConstraintExpression\",\n \"target_resource_type\": \"Group\",\n \"count\": 100,\n \"operator\": \"<=\"\n }, {\n \"resource_type\": \"EntityInstanceCountConstraintExpression\",\n \"target_resource_type\": \"VpcSubnet\",\n \"count\": 10,\n \"operator\": \"<=\"\n }],\n \"targets\": [{\n \"path_prefix\": \"/orgs/default/projects/project-1/vpcs/vpc-1/\"\n }]\n}\n\n4. PATCH https://<policy-mgr>policy/api/v1/infra/constraints/related-attribute-constraint\n{\n \"targets\":[{\n \"target_resource_type\":\"SecurityPolicy.Rule\",\n \"attribute\":\"services\",\n \"path_prefix\": \"/infra/domains/{{DOMAIN}}/security-policies/default/rules/rule1\"\n }],\n \"constraint_expressions\": [{\n \"resource_type\": \"RelatedAttributeConditionalExpression\",\n \"related_attribute\":{\n \"attribute\":\"destinationGroups\"\n },\n \"condition\" : {\n \"operator\":\"INCLUDES\",\n \"rhs_value\": [\"/infra/domains/mgw/groups/VCENTER\"],\n \"value_constraint\": {\n \"resource_type\": \"ValueConstraintExpression\",\n \"operator\":\"INCLUDES\",\n \"values\":[\"/infra/services/HTTP\", \"/infra/services/HTTPS\"]\n }\n }\n }]\n}\n",
"x-vmw-nsx-module": "PolicyConstraints",
"x-codegen-request-body-name": "Constraint"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{ids-policy-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Statistics"
],
"summary": "Get IDS security policy statistics",
"description": "Get statistics of a IDS security policy.\n- no enforcement point path specified: Stats will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIdsSecurityPolicyStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ids-policy-id",
"in": "path",
"description": "IDS Security policy id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsSecurityPolicyStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/intrusion-service-policies/sp-1/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyIDSStats",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"enforcement_point\": \"/infra/sites/default/enforcement-points/default\",\n \"statistics\": {\n \"internal_section_id\": \"fcb7390d-8289-4a0e-9cee-5423748cc544\",\n \"results\": [\n {\n \"internal_rule_id\": \"2024\",\n \"packet_count\": 3845230,\n \"byte_count\": 266243732,\n \"session_count\": 57119,\n \"hit_count\": 57119\n }\n ],\n \"result_count\": 1\n }\n }\n ],\n \"result_count\": 1\n }\n"
}
},
"/infra/full-sync-states/{full-sync-id}": {
"get": {
"tags": [
"Federation",
"Full Synchronization"
],
"summary": "Get full sync state",
"description": "Get full sync state.",
"operationId": "GetFullSyncStates",
"parameters": [
{
"name": "full-sync-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullSyncState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/full-sync-states/1234\n",
"x-vmw-nsx-module": "PolicyFullSync",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"FullSyncState\",\n \"id\": \"1234\",\n \"full_sync_id\": \"1234\",\n \"last_completed_stage\": \"PROCESSED_DELTAS\",\n \"path\": \"/infra/fullsync-states/1234\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"1234\",\n \"_create_user\": \"SYSTEM\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"SYSTEM\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": true,\n \"_revision\": 2\n}\n"
}
},
"/ui-views/{view-id}": {
"get": {
"tags": [
"System Administration",
"Monitoring",
"Dashboards",
"UI Views"
],
"summary": "Returns View Information",
"description": "Returns Information about a specific View.\n\n
\nThis API is deprecated and will be unavailable in later releases.",
"operationId": "GetView",
"parameters": [
{
"name": "view-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/View"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/ui-views/View_abe34406a\n",
"x-vmw-nsx-module": "NsxDashboard",
"x-vmw-nsx-example-response": "{\n \"id\": \"View_abe34406a\",\n \"resource_type\": \"View\",\n \"display_name\": \"My View 2\",\n \"shared\": true,\n \"weight\": 19021,\n \"widgets\": [{\n \"widget_id\": \"DonutConfiguration_Edge-Nodes-Deployment\",\n \"label\": {\n \"text\": \"Deployment\"\n },\n \"weight\": 9532\n },{\n \"widget_id\": \"DonutConfiguration_Edge-Nodes-Connectivity\",\n \"label\": {\n \"text\": \"Connectivity\"\n },\n \"weight\": 9536\n }],\n \"_create_user\": \"admin\",\n \"_create_time\": 1496911709362,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1496911709362,\n \"_system_owned\": false,\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"System Administration",
"Monitoring",
"Dashboards",
"UI Views"
],
"summary": "Update View",
"description": "Update View\n
\nThis API is deprecated and will be unavailable in later releases.",
"operationId": "UpdateView",
"parameters": [
{
"name": "view-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/View"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/View"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/api/v1/ui-views/View_0de8406c\n{\n \"resource_type\": \"View\",\n \"display_name\": \"My View 1 Updated\",\n \"shared\": true,\n \"weight\": 19020,\n \"widgets\": [{\n \"widget_id\": \"DonutConfiguration_Host-Nodes-Deployment\",\n \"label\": {\n \"text\": \"Deployment\"\n },\n \"weight\": 9531\n },{\n \"widget_id\": \"DonutConfiguration_Host-Nodes-Connectivity\",\n \"label\": {\n \"text\": \"Connectivity\"\n },\n \"weight\": 9535\n }],\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "NsxDashboard",
"x-vmw-nsx-example-response": "{\n \"id\": \"View_0de8406c\",\n \"resource_type\": \"View\",\n \"display_name\": \"My View 1 Updated\",\n \"shared\": true,\n \"weight\": 19020,\n \"widgets\": [{\n \"widget_id\": \"DonutConfiguration_Host-Nodes-Deployment\",\n \"label\": {\n \"text\": \"Deployment\"\n },\n \"weight\": 9531\n },{\n \"widget_id\": \"DonutConfiguration_Host-Nodes-Connectivity\",\n \"label\": {\n \"text\": \"Connectivity\"\n },\n \"weight\": 9535\n }],\n \"_create_user\": \"admin\",\n \"_create_time\": 1496911709362,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1496911902685,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "View"
},
"delete": {
"tags": [
"System Administration",
"Monitoring",
"Dashboards",
"UI Views"
],
"summary": "Delete View",
"description": "Delete View\n
\nThis API is deprecated and will be unavailable in later releases.",
"operationId": "DeletView",
"parameters": [
{
"name": "view-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/api/v1/ui-views/View_0de8406c\n",
"x-vmw-nsx-module": "NsxDashboard"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/sites/agents/metrics": {
"get": {
"summary": "Fetch current Metric agent config",
"description": "Fetch current Metric agent config",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetMetricsAgent",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsAgent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy>/policy/api/v1/infra/sites/agents/metrics\n",
"x-vmw-nsx-module": "MetricsAgent",
"x-vmw-nsx-example-response": "{\n \"correlation_id\": \"545ec14f-56f8-4585-bbf4-6bd859bf9463\",\n \"receiver_endpoint\": \"nsx-metrics.vdp.vmware.com\",\n \"org_id\": \"org1\",\n \"instance_id\": \"abcec14f-56f8-4585-bbf4-6bd859bf9def\",\n \"admin_action\": \"ONBOARD\",\n \"log_level\": \"INFO\",\n \"enable_time_series_metrics_ingestion\" : false,\n \"_revision\": 2\n}\n"
},
"put": {
"summary": "Create Metrics agent intent resource",
"description": "Create Metrics agent intent resource",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdateMetricsAgent",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsAgent"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsAgent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy>/policy/api/v1/infra/sites/agents/metrics\n{\n \"correlation_id\": \"545ec14f-56f8-4585-bbf4-6bd859bf9463\",\n \"receiver_endpoint\": \"nsx-metrics.vdp.vmware.com\",\n \"org_id\": \"org1\",\n \"instance_id\": \"abcec14f-56f8-4585-bbf4-6bd859bf9def\",\n \"admin_action\": \"ONBOARD\",\n}\n",
"x-vmw-nsx-module": "MetricsAgent",
"x-vmw-nsx-example-response": "{\n \"correlation_id\": \"545ec14f-56f8-4585-bbf4-6bd859bf9463\",\n \"receiver_endpoint\": \"nsx-metrics.vdp.vmware.com\",\n \"org_id\": \"org1\",\n \"instance_id\": \"abcec14f-56f8-4585-bbf4-6bd859bf9def\",\n \"admin_action\": \"ONBOARD\",\n \"log_level\": \"INFO\",\n \"enable_time_series_metrics_ingestion\" : false,\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "MetricsAgent"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/host-transport-nodes/{host-transport-node-id}?action=resync_host_config": {
"post": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Nodes"
],
"summary": "Resync a Host Transport Node",
"description": "Resync the TransportNode configuration on a host.\nIt is similar to updating the TransportNode with existing configuration,\nbut force synce these configurations to the host (no backend optimizations).\n",
"operationId": "ResyncHostTransportNode",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "host-transport-node-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes//97a8c255-0dea-4561-8054-4d5027d8e19d?action=resync_host_config\n",
"x-vmw-nsx-module": "PolicyHostTransportNode"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Routing",
"Static Routes"
],
"summary": "List Tier-1 Static Routes",
"description": "Paginated list of all Tier-1 Static Routes\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1StaticRoutes",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutesListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/static-routes\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"StaticRoutes\",\n \"id\": \"site1\",\n \"display_name\": \"/infra/tier-1s/cgw/static-routes/site1\",\n \"path\": \"/infra/tier-1s/cgw/static-routes/site1\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"site1\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"network\": \"45.1.1.0/24\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516750267338,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516750267338,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/firewall-flood-protection-profile-binding-maps/{firewall-flood-protection-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Get Firewall Flood Protection Profile Binding Map",
"description": "API will get Firewall Flood Protection Profile Binding Map\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPolicyFirewallFloodProtectionBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain-ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"binding-map-1\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallFloodProtectionProfileBindingMaps\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Update Firewall Flood Protection Profile Binding Map",
"description": "API will update Firewall Flood Protection Profile Binding Map",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdatePolicyFirewallFloodProtectionBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "DomainID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n{\n \"resource_type\":\" PolicyFirewallFloodProtectionProfileBindingMap\",\n \"display_name\": \"binding-map-1\",\n \"description\":\"\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallFloodProtectionProfileBindingMaps\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PolicyFirewallFloodProtectionProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Delete Firewall Flood Protection Profile Binding",
"description": "API will delete Firewall Flood Protection Profile Binding",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeletePolicyFirewallFloodProtectionBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Create or update Firewall Flood Protection Profile Binding Map",
"description": "API will create or update Firewall Flood Protection profile binding map",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchPolicyFirewallFloodProtectionProfileBindingMap",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n {\n \"resource_type\":\" PolicyFirewallFloodProtectionProfileBindingMap\",\n \"display_name\": \"binding-map-1\",\n \"description\":\"\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-codegen-request-body-name": "PolicyFirewallFloodProtectionProfileBindingMap"
}
},
"/global-infra/group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given object is a member",
"description": "Get policy groups for which the given object is a member.\nIn Federation environment, if the given object is a global entity\n(eg: global segment) and if the entity is not stretched to the site\nspecified in the enforcement_point_path parameter,then the following is returned:-\n1)If the entity is a member of any global group and that group is stretched\n to the enforcement_point_path site,then the API returns an empty list.\n2)If the entity is not a member of any global group,this API returns\n an 'invalid path' error message.\n3)If both the entity and its corresponding groups are stretched to the\n enforcement_point_path site , then the API returns the groups list.\n",
"operationId": "GlobalInfraGetGroupsForObject",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "intent_path",
"in": "query",
"description": "String path of the intent object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/group-associations?intent_path=/infra/segment/s1&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n }\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Details of QoS profile\n",
"description": "API will return details of QoS profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadQoSProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_2\n",
"x-vmw-nsx-module": "PolicyQoS",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"QoSProfile\",\n \"id\": \"profile_2\",\n \"display_name\": \"/infra/qos-profiles/profile_2\",\n \"path\": \"/infra/qos-profiles/profile_2\",\n \"parent_path\": \"/infra/domains/d1/groups/group_vm\",\n \"relative_path\": \"profile_2\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Create or Replace QoS profile.",
"description": "Create or Replace QoS profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrReplaceQoSProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_2\n{\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2\n}\n",
"x-vmw-nsx-module": "PolicyQoS",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"QoSProfile\",\n \"id\": \"profile_2\",\n \"display_name\": \"profile_2\",\n \"path\": \"/infra/qos-profiles/profile_2\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile_2\",\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "QoSProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Delete QoS profile",
"description": "API will delete QoS profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteQoSProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_1\n",
"x-vmw-nsx-module": "PolicyQoS"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Patch QoS profile.",
"description": "Create a new QoS profile if the QoS profile with\ngiven id does not already exist. If the QoS profile with the\ngiven id already exists, patch with the existing QoS profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchQoSProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_1\n{\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2\n}\n",
"x-vmw-nsx-module": "PolicyQoS",
"x-codegen-request-body-name": "QoSProfile"
}
},
"/infra/tier-0s/{tier-0-id}/dns-forwarder": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Read the DNS Forwarder for the given tier-0 instance",
"description": "Read the DNS Forwarder for the given tier-0 instance",
"operationId": "ReadPolicyDnsForwarderOnTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyDnsForwarder\",\n \"id\" : \"dns-forwarder\",\n \"display_name\" : \"dns-forwarder\",\n \"path\" : \"/infra/tier-0s/prv/dns-forwarder\",\n \"parent_path\" : \"/infra/tier-0s/prv\",\n \"relative_path\" : \"dns-forwarder\",\n \"listener_ip\" : \"5.5.5.5\",\n \"conditional_forwarder_zone_paths\" : [ \"/infra/dns-forwarder-zones/conditional-1\" ],\n \"log_level\" : \"INFO\",\n \"enabled\" : true,\n \"default_forwarder_zone_path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Update the DNS Forwarder",
"description": "Update the DNS Forwarder",
"operationId": "UpdatePolicyDnsForwarderOnTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarder"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder\n{\n \"display_name\" : \"dns-forwarder\",\n \"listener_ip\" : \"5.5.5.5\",\n \"default_forwarder_zone_path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"conditional_forwarder_zone_paths\" : [\"/infra/dns-forwarder-zones/conditional-1\"],\n \"enabled\": false,\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyDnsForwarder\",\n \"id\" : \"dns-forwarder\",\n \"display_name\" : \"dns-forwarder\",\n \"path\" : \"/infra/tier-0s/prv/dns-forwarder\",\n \"parent_path\" : \"/infra/tier-0s/prv\",\n \"relative_path\" : \"dns-forwarder\",\n \"listener_ip\" : \"5.5.5.5\",\n \"conditional_forwarder_zone_paths\" : [ \"/infra/dns-forwarder-zones/conditional-1\" ],\n \"log_level\" : \"INFO\",\n \"enabled\" : false,\n \"default_forwarder_zone_path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n",
"x-codegen-request-body-name": "PolicyDnsForwarder"
},
"post": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Perform the specified DNS forwarder action",
"description": "Perform the specified action for Tier0 DNS forwarder on specified enforcement point.\n",
"operationId": "PerformEPActionForDnsForwarderAtTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "An action to be performed for DNS forwarder on EP",
"required": true,
"schema": {
"type": "string",
"enum": [
"clear_cache"
]
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "An enforcement point path, on which the action is to be performed",
"schema": {
"type": "string",
"default": "/infra/sites/default/enforcement-points/default"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "1. Clear cache\nPOST https://<policy-mgr>/policy/api/v1/infra/tier-0s/tier0/dns-forwarder?action=clear_cache\n",
"x-vmw-nsx-module": "PolicyDnsForwarder"
},
"delete": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Delete DNS configuration for tier-0 instance",
"description": "Delete DNS configuration for tier-0 instance",
"operationId": "DeletePolicyDnsForwarderOnTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder\n",
"x-vmw-nsx-module": "PolicyDnsForwarder"
},
"patch": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Update the DNS Forwarder",
"description": "Update the DNS Forwarder",
"operationId": "PatchPolicyDnsForwarderOnTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarder"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder\n{\n \"display_name\" : \"dns-forwarder\",\n \"listener_ip\" : \"5.5.5.5\",\n \"default_forwarder_zone_path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"conditional_forwarder_zone_paths\" : [\"/infra/dns-forwarder-zones/conditional-1\"]\n}\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-codegen-request-body-name": "PolicyDnsForwarder"
}
},
"/infra/tier-0s/{tier0-id}/locale-services/{locale-services-id}/session-timer-profile-bindings/{session-timer-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices",
"description": "API will get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices.\n",
"operationId": "GetTier0LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/locale-services/default/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/locale-services/default/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices",
"description": "API will create or update Session Timer profile binding map for Tier-0 Logical Router LocaleServices.",
"operationId": "UpdateTier0LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/locale-services/default/session-timer-profile-bindings/default\n {\n \"resource_type\":\"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/locale-services/default/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Delete Session Timer Profile Binding for Tier-0 Logical Router LocaleServices",
"description": "API will delete Session Timer Profile Binding for Tier-0 Logical Router LocaleServices.",
"operationId": "DeleteTier0LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/locale-services/default/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices",
"description": "API will create or update Session Timer profile binding map for Tier-0 Logical Router LocaleServices.",
"operationId": "PatchTier0LocalServicesSessionTimerProfileBindingMap",
"parameters": [
{
"name": "tier0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-0s/my-t0/locale-services/default/session-timer-profile-bindings/default\n {\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Get IPSec tunnel Profile",
"description": "Get custom IPSec tunnel Profile, given the particular id.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIPSecVpnTunnelProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"path\": \"/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\",\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Create or fully replace a custom IPSec tunnel Profile",
"description": "Create or fully replace custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdateIPSecVpnTunnelProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\n{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\"\n \"_revision\" : 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"path\": \"/infra/ipsec-vpn-ike-profiles/aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\",\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnTunnelProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Delete custom IPSec tunnel Profile",
"description": "Delete custom IPSec tunnel Profile. Profile can not be deleted if profile has references to it.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteIPSecVpnTunnelProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Create or patch a custom IPSec tunnel Profile",
"description": "Create or patch custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrPatchIPSecVpnTunnelProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\n{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\"\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnTunnelProfile"
}
},
"/global-infra/domains/{domain-id}/groups/{group-id}/firewall-flood-protection-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "List Firewall Flood Protection Profile Binding Maps",
"description": "API will list all Firewall Flood Protection Profile Binding Maps in current group id.\n",
"operationId": "GlobalInfraListPolicyFirewallFloodProtectionBindings",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"binding-map-1\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallFloodProtectionProfileBindingMaps\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-1 router link statistics summary information",
"description": "Get tier-1 router link statistics summary information.\n",
"operationId": "GetTier1RouterLinkSummaryStatistics",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatisticsSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/production_t1/tier-0-interface/statistics/summary\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_policy_path\": \"/infra/realized-state/enforcement-points/default/logical-ports/pepsi-production_t1-t1_lrp\",\n \"last_update_timestamp\": 1705966281748,\n \"rx\": {\n \"total_bytes\": 0,\n \"total_packets\": 0,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"destination_unsupported_dropped_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"ipv6_dropped_packets\": 0,\n \"kni_dropped_packets\": 0,\n \"l4port_unsupported_dropped_packets\": 0,\n \"malformed_dropped_packets\": 0,\n \"no_receiver_dropped_packets\": 0,\n \"no_route_dropped_packets\": 0,\n \"proto_unsupported_dropped_packets\": 0,\n \"redirect_dropped_packets\": 0,\n \"rpf_check_dropped_packets\": 0,\n \"ttl_exceeded_dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 111342,\n \"total_packets\": 2651,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"dad_dropped_packets\": 0,\n \"frag_needed_dropped_packets\": 0,\n \"ipsec_pol_block_dropped_packets\": 0,\n \"ipsec_pol_err_dropped_packets\": 0,\n \"no_arp_dropped_packets\": 0,\n \"no_linked_dropped_packets\": 0,\n \"no_mem_dropped_packets\": 0,\n \"non_ip_dropped_packets\": 0,\n \"service_insert_dropped_packets\": 0\n },\n \"logical_router_port_id\": \"bf93e461-804e-4730-8709-56c753eb46d2\"\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "List Tier-0 Interfaces",
"description": "Paginated list of all Tier-0 Interfaces\n",
"operationId": "ListTier0Interfaces",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0InterfaceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/interfaces\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Tier0Interface\",\n \"id\": \"to_internet\",\n \"display_name\": \"to_internet\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/default/interfaces/to_internet\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv/locale-services/default\",\n \"relative_path\": \"to_internet\",\n \"segment_path\": \"/infra/segments/sg-uplink\",\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"edge_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\",\n \"type\": \"EXTERNAL\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains": {
"get": {
"tags": [
"Policy",
"Infra",
"Domains",
"Domain"
],
"summary": "List domains for infra",
"description": "Paginated list of all domains for infra.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListDomainForInfra",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Domain\",\n \"description\": \"VMC Domain\",\n \"id\": \"vmc\",\n \"display_name\": \"VMC domain\",\n \"path\": \"/infra/domains/vmc\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"vmc\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517307910473,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517307910473,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/ipv6-dad-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"IPV6 DAD Profiles"
],
"summary": "List all IPv6 DAD profiles",
"description": "Paginated list of all IPv6 DAD profile instances\n",
"operationId": "ListIpv6DadProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ipv6DadProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipv6-dad-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"dad_mode\": \"LOOSE\",\n \"wait_time\": 1,\n \"ns_retries\": 3,\n \"resource_type\": \"Ipv6DadProfile\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/ipv6-dad-profiles/default\",\n \"relative_path\": \"default\",\n \"parent_path\": \"/infra/ipv6-dad-profiles/default\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1553814058782,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1553814058782,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/virtual-machine-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given VM is a member",
"description": "Get policy groups for which the given VM is a member.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGroupsForVM",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "vm_external_id",
"in": "query",
"description": "Virtual machine external ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/virtual-machine-group-associations?vm_external_id=564de333-15ac-de52-da90-974fe099a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/host-transport-nodes/{host-transport-node-id}/discovered-vifs": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Nodes"
],
"summary": "Fetch Discovered VIF State on given TransportNode",
"description": "For the given TransportNode, fetch all the VIF info from VC and\nreturn the corresponding state. Only host switch configured for\nsecurity will be considered.\n",
"operationId": "ListVdsVifsOnTransportNode",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "host-transport-node-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "host_switch_id",
"in": "query",
"description": "VDS identifier",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "segment_id",
"in": "query",
"description": "Segment identifier",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiscoveredVifStateListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/8538f119-ba45-4fb1-9cf1-ee849e4cf168/discovered-vifs\n",
"x-vmw-nsx-module": "PolicyHostTransportNode",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"id\": \"1895707572\",\n \"segment_port_path\": \"/infra/segments/780d20f8-f5b6-4a67-a0dc-5340e8b54065:dvportgroup-15/ports/default:6593a728-55af-4b82-9801-2e4b34b078e9\",\n \"segment_path\": \"/infra/segments/780d20f8-f5b6-4a67-a0dc-5340e8b54065:dvportgroup-15\",\n \"state\": \"ATTACHMENT_SUCCESS\"\n }\n ]\n}\n"
}
},
"/global-infra/segments/{segment-id}/effective-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "List all effective profiles for infra segment",
"description": "List all effective profiles for this segment on given enforcement point.",
"operationId": "GlobalInfraListInfraSegmentEffectiveProfiles",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectiveProfilesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/tier0-ls/effective-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Statistics"
],
"summary": "Get rule statistics",
"description": "Get statistics of a rule.\n- no enforcement point path specified: Stats will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "GetRuleStatistics",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"description": "Security policy id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/communciation-maps/emergency/rules/ce-1/statistics?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n {\n \"rule\": \"ce-1\",\n \"packet_count\": 3806,\n \"session_count\": 819,\n \"hit_count\": 345,\n \"byte_count\": 322989,\n \"popularity_index\": 85,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n }\n ],\n \"cursor\" : 1,\n \"result_count\" : 1\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"TEP Table"
],
"summary": "Get tier-1 segment TEP table",
"description": "Returns TEP table for a segment\n",
"operationId": "GlobalInfraGetTier1SegmentTepTable",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTepListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH/tep-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"last_update_timestamp\": 1591745956155,\n \"results\": [\n {\n \"tep_label\": 55298,\n \"tep_ip\": \"100.100.100.3\",\n \"tep_mac_address\": \"00:50:56:6a:af:ce\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/aaa/ldap-identity-sources?action=probe_identity_source": {
"post": {
"tags": [
"System Administration",
"Settings",
"User Management",
"LDAP Identity Sources"
],
"summary": "Probe an LDAP identity source",
"description": "Verify that the configuration of an LDAP identity source is correct before actually creating the source.",
"operationId": "ProbeUnconfiguredLdapIdentitySource",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapIdentitySource"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapIdentitySourceProbeResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST /policy/api/v1/aaa/ldap-identity-sources?action=probe\n{\n \"resource_type\": \"ActiveDirectoryIdentitySource\",\n \"display_name\": \"Airius LDAP\",\n \"domain_name\": \"airius.com\",\n \"base_dn\": \"CN=Users, DC=airius, DC=com\",\n \"ldap_servers\": [\n \"url\": \"ldap://ldap-vip01.corp.airius.com\",\n \"use_starttls\": true,\n \"certificate\": \"-----BEGIN CERTIFICATE----- <data> -----END CERTIFICATE-----\",\n \"bind_identity\": \"nsxint@airius.com\",\n \"password\": \"gSSs77w33yMp\"\n ]\n}\n",
"x-vmw-nsx-module": "LdapIdentitySources",
"x-vmw-nsx-example-response": "200 OK\n{\n \"results\": [\n \"url\": \"ldap://ldap-vip01.corp.airius.com\",\n \"result\": \"FAILURE\",\n \"errors\": [\n \"INVALID_CREDENTIALS\"\n ]\n ]\n}\n",
"x-codegen-request-body-name": "LdapIdentitySource"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/flood-protection-profiles/{flood-protection-profile-id}/bindings": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profiles"
],
"summary": "List Flood Protection Profiles",
"description": "API will list all Flood Protection Profiles bindings.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListFloodProtectionProfileBindings",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "flood-protection-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/flood-protection-profiles/profile-1/bindings\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"name\": \"default\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\" : \"/infra/flood-protection-profiles/profile-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/aaa/roles?action=validate": {
"post": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Validate a new feature permission set",
"description": "Validate the permissions of an incoming role. Also, recommend the\npermissions which need to be corrected.\n",
"operationId": "ValidateAndRecommendPermissions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeaturePermissionArray"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecommendedFeaturePermissionListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "{\n \"feature_permissions\": [\n {\n \"feature\": \"policy_lb\",\n \"permission\": \"crud\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "AAA",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"target_feature\": \"policy_t1\",\n \"src_features\": [\n \"policy_lb\"\n ],\n \"recommended_permissions\": [\n \"crud\",\n \"read\"\n ]\n }\n ],\n \"result_count\": 1\n}\n",
"x-codegen-request-body-name": "FeaturePermissionArray"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Tags"
],
"summary": "Get details of tag bulk operation request",
"description": "Get details of tag bulk operation request with which tag is applied or removed\non virtual machines.\n",
"operationId": "GetVpcTagBulkOperation",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "operation-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagBulkOperation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/tags/vpc-tag-operations/win-vm-update\n",
"x-vmw-nsx-module": "PolicyVpcTag",
"x-vmw-nsx-example-response": "{\n \"tag\": {\n \"scope\": \"os\",\n \"tag\": \"windows\"\n },\n \"apply_to\": [\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_ids\": [\n \"ee98a906-7b84-42ae-9413-d812cdb64543\"\n ]\n }\n ],\n \"remove_from\":[\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_ids\": [\n \"564d8b81-983d-b8ef-686b-161205939c58\"\n ]\n }\n ],\n \"resource_type\": \"TagBulkOperation\",\n \"id\": \"win-vm-update\",\n \"display_name\": \"win-vm-update\",\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/tags/vpc-tag-operations/win-vm-update\",\n \"relative_path\": \"win-vm-update\",\n \"parent_path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/tags/vpc-tag-operations\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544641564432,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544641564432,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Tags"
],
"summary": "Assign or Unassign tag on multiple Virtual Machines.",
"description": "Tag can be assigned or unassigned on multiple objects. Supported object type is\nrestricted to Virtual Machine for now and support for other objects will be added\nlater. Permissions for tag bulk operation would be similar to virtual machine\ntag permissions.\n",
"operationId": "VpcTagBulkUpdate",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "operation-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagBulkOperation"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagBulkOperation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/tags/vpc-tag-operations/win-vm-update\n{\n \"tag\": {\n \"scope\": \"os\",\n \"tag\": \"windows\"\n },\n \"apply_to\": [\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_ids\": [\n \"ee98a906-7b84-42ae-9413-d812cdb64543\"\n ]\n }\n ],\n \"remove_from\":[\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_ids\": [\n \"564d8b81-983d-b8ef-686b-161205939c58\"\n ]\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyVpcTag",
"x-vmw-nsx-example-response": "{\n \"tag\": {\n \"scope\": \"os\",\n \"tag\": \"windows\"\n },\n \"apply_to\": [\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_ids\": [\n \"ee98a906-7b84-42ae-9413-d812cdb64543\"\n ]\n }\n ],\n \"remove_from\":[\n {\n \"resource_type\": \"VirtualMachine\",\n \"resource_ids\": [\n \"564d8b81-983d-b8ef-686b-161205939c58\"\n ]\n }\n ],\n \"resource_type\": \"TagBulkOperation\",\n \"id\": \"win-vm-update\",\n \"display_name\": \"win-vm-update\",\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/tags/vpc-tag-operations/win-vm-update\",\n \"relative_path\": \"win-vm-update\",\n \"parent_path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/tags/vpc-tag-operations\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544641564432,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544641564432,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "TagBulkOperation"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ip-blocks": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Blocks"
],
"summary": "List IpAddressBlocks",
"description": "Paginated list of IpAddressBlocks.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIpAddressBlocks",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressBlockListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-blocks\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"IpAddressBlock\",\n \"id\": \"Finance-block\",\n \"display_name\": \"Finance-block\",\n \"path\": \"/infra/ip-blocks/Finance-block\",\n \"parent_path\": \"/infra/ip-blocks\",\n \"relative_path\": \"Finance-block\",\n \"cidr\": \"192.168.0.0/16\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given object is a member",
"description": "Get policy groups for which the given object is a member.\nIn Federation environment, if the given object is a global entity\n(eg: global segment) and if the entity is not stretched to the site\nspecified in the enforcement_point_path parameter,then the following is returned:-\n1)If the entity is a member of any global group and that group is stretched\n to the enforcement_point_path site,then the API returns an empty list.\n2)If the entity is not a member of any global group,this API returns\n an 'invalid path' error message.\n3)If both the entity and its corresponding groups are stretched to the\n enforcement_point_path site , then the API returns the groups list.\n",
"operationId": "GetGroupsForObject",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "intent_path",
"in": "query",
"description": "String path of the intent object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/group-associations?intent_path=/infra/segment/s1&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n }\n }\n ]\n}\n"
}
},
"/infra/lb-ssl-ciphers-and-protocols": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer SSL Profiles",
"Load Balancer SSL Ciphers And Protocols"
],
"summary": "Retrieve a list of supported SSL ciphers and protocols",
"description": "Retrieve a list of supported SSL ciphers and protocols.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "ListSslCiphersAndProtocols",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LbSslCipherAndProtocolListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https:///<policy-mgr>/policy/api/v1/infra/lb-ssl-ciphers-and-protocols\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 35,\n \"ciphers\" : [ {\n \"cipher\" : \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\",\n \"HIGH_SECURITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"HIGH_SECURITY\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_RSA_WITH_AES_256_CBC_SHA\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_RSA_WITH_AES_256_CBC_SHA256\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_RSA_WITH_AES_256_GCM_SHA384\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\",\n \"HIGH_SECURITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\",\n \"HIGH_SECURITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n }, {\n \"cipher\" : \"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384\",\n \"cipher_group_labels\" : [ \"CUSTOM\" ],\n \"is_secure\" : true,\n \"is_default\" : false\n }, {\n \"cipher\" : \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\",\n \"cipher_group_labels\" : [ \"CUSTOM\", \"BALANCED\", \"HIGH_COMPATIBILITY\",\n \"HIGH_SECURITY\" ],\n \"is_secure\" : true,\n \"is_default\" : true\n } ],\n \"protocols\" : [ {\n \"protocol\" : \"TLS_V1_2\",\n \"is_secure\" : true,\n \"is_default\" : true\n } ]\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Enablement"
],
"summary": "Read IDS config",
"description": "Read intrusion detection system config of standalone hosts.\n",
"operationId": "GetIdsStandaloneHostConfig",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsStandaloneHostConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"ids_enabled\": false,\n \"resource_type\": \"IdsStandaloneHostConfig\",\n \"id\": \"ids-standalone-host-config\",\n \"display_name\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"relative_path\": \"ids-standalone-host-config\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1559807855627,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1559810459486,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Enablement"
],
"summary": "Create or update IDS configuration",
"description": "Update intrusion detection system configuration on standalone hosts.",
"operationId": "CreateOrUpdateIdsStandaloneHostConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsStandaloneHostConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsStandaloneHostConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\n{\n \"ids_enabled\": true,\n \"resource_type\": \"IdsStandaloneHostConfig\",\n \"id\": \"ids-standalone-host-config\",\n \"display_name\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"relative_path\": \"ids-standalone-host-config\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1559807855627,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1559810459486,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"ids_enabled\": true,\n \"resource_type\": \"IdsStandaloneHostConfig\",\n \"id\": \"ids-standalone-host-config\",\n \"display_name\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"relative_path\": \"ids-standalone-host-config\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1559807855627,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1559810459486,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "IdsStandaloneHostConfig"
},
"patch": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Enablement"
],
"summary": "Patch IDS configuration",
"description": "Patch intrusion detection system configuration on standalone hosts.",
"operationId": "PatchIdsStandaloneHostConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsStandaloneHostConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\n{\n \"ids_enabled\": true,\n \"resource_type\": \"IdsStandaloneHostConfig\",\n \"id\": \"ids-standalone-host-config\",\n \"display_name\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config\",\n \"relative_path\": \"ids-standalone-host-config\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1559807855627,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1559810459486,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-codegen-request-body-name": "IdsStandaloneHostConfig"
}
},
"/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Get Infra Port Discovery Profile Binding Map",
"description": "API will get Infra Port Discovery Profile Binding Map\n",
"operationId": "GetInfraPortDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Infra Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Update Infra Port Discovery Profile Binding Map",
"description": "API will update Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "UpdateInfraPortDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Infra Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n{\n \"resource_type\":\" PortDiscoveryProfileBindingMap\",\n \"display_name\": \"PortDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortDiscoveryProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Delete Infra Port Discovery Profile Binding Profile",
"description": "API will delete Infra Port Discovery Profile Binding Profile",
"operationId": "DeleteInfraPortDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Infra Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Create Infra Port Discovery Profile Binding Map",
"description": "API will create Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "PatchInfraPortDiscoveryBinding",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"description": "Infra Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n {\n \"resource_type\":\" PortDiscoveryProfileBindingMap\",\n \"display_name\": \"PortDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n }\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-codegen-request-body-name": "PortDiscoveryProfileBindingMap"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from segment interface (downlink)",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the\ninterface (downlink) attaching segment to tier-1 gateway, on a edge\nnode specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "GetSegmentInterfaceArpTable",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/segments/web-app-seg/arp-table?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"displayName\",\n \"result_count\": 3,\n \"interface_path\": \"/infra/realized-state/enforcement-points/default/logical-ports/t1-web-app-seg-dlrp\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\",\n example_response: |\n \"results\": [\n {\n \"mac_address\": \"00:50:56:8e:b4:21\",\n \"ip\": \"172.16.10.21\"\n },\n {\n \"mac_address\": \"02:50:56:56:44:52\",\n \"ip\": \"172.16.10.1\"\n },\n {\n \"mac_address\": \"00:50:56:8e:91:12\",\n \"ip\": \"172.16.10.11\"\n }\n ]\n}\n"
}
},
"/global-infra/dhcp-server-configs/{config-id}/stats?action=reset": {
"post": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Reset DHCP server statistics counters",
"description": "Reset DHCP statistics counters of a DHCP server represented by the\nconnectivity_path and the enforecement_point_path where the\ndhcp-server-config was applied to. The connectivity_path can be the Tier0\npath, Tier1 path or a segment path. If the given Tier0/1 or Segment has\nDHCP server applied, the resetting will succeed and the DHCP statistics\ncounters will be reset to 0. But if it has no DHCP server applied, the\nreseting will fail with proper error message.\n",
"operationId": "GlobalInfraResetDhcpServerStats",
"parameters": [
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/stats?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{}\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"ARP Proxies"
],
"summary": "Get Tier-1 Address Resolution Protocol Proxies",
"description": "Get Tier-1 Address Resolution Protocol Proxies.\n
\nThis API is deprecated. Please use /infra/tier-1s/<tier-1-id>/arp-proxies\nReturns ARP proxy table for a tier-1\n",
"operationId": "GetTier1ArpProxies",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s/pepsi/locale-services/1-policyconnectivity-1340/arp-proxies\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"22\",\n \"arp_proxy_ip\" : \"10.22.2.42\"\n },\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"EVPN Setting",
"EVPN Tunnel Endpoints"
],
"summary": "List evpn tunnel endpoint configuration",
"description": "List all evpn tunnel endpoint configuration.\n",
"operationId": "ListEvpnTunnelEndpointConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvpnTunnelEndpointConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyConnectivity"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/byod-service-instances/{service-instance-id}/service-instance-endpoints": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-0 Gateways"
],
"summary": "List all service instance endpoint",
"description": "List all service instance endpoint",
"operationId": "ListPolicyServiceInstanceEndpoints",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpointListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n\"sort_ascending\":true,\n\"result_count\":1,\n\"results\":[\n {\n \"resource_type\" : \"ServiceInstanceEndpoint\",\n \"id\" : \"SIE_1\",\n \"display_name\" : \"SIE_1\",\n \"path\" : \"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\",\n \"parent_path\" : \"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1\",\n \"relative_path\" : \"SIE_1\",\n \"marked_for_delete\" : false,\n \"endpoint_type\" : \"LOGICAL\",\n \"target_ips\" : [ {\n \"ip_addresses\" : [ \"135.1.1.1\" ]\n } ],\n \"service_interface_path\" : \"/infra/tier-0s/vmc/locale-services/default/service-interfaces/SITF_1\",\n \"_create_time\" : 1524826554351,\n \"_last_modified_user\" : \"admin\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_last_modified_time\" : 1524826554351,\n \"_create_user\" : \"admin\",\n \"_revision\" : 0\n }\n]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "List Segment Discovery Profile Binding Maps",
"description": "API will list all Segment Discovery Profile Binding Maps in current segment id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListSegmentDiscoveryBindings",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-discovery-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"State"
],
"summary": "Get tier-1 segment port state",
"description": "Returns tier-1 segment port state on enforcement point\n",
"operationId": "GlobalInfraGetTier1SegmentPortState",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/TIER1_DOWNLINK_SWITCH/ports/default:d03f67f8-efd0-491b-955e-82d8323cffa0/state\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"transport_node_ids\": [\n \"01b3242e-a7c8-11ea-9a01-278a0b44b8c9\"\n ],\n \"discovered_bindings\": [\n {\n \"source\": \"VM_TOOLS\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591432722000\n },\n {\n \"source\": \"ARP_SNOOPING\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591853619530\n }\n ],\n \"realized_bindings\": [\n {\n \"source\": \"VM_TOOLS\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591432722000\n },\n {\n \"source\": \"ARP_SNOOPING\",\n \"binding\": {\n \"ip_address\": \"192.168.100.162\",\n \"mac_address\": \"00:0c:29:46:b0:72\",\n \"vlan\": 0\n },\n \"binding_timestamp\": 1591434843090\n }\n ],\n \"duplicate_bindings\": [],\n \"attachment\": {\n \"id\": \"ef25f3f5-f19a-4aa2-9c6a-842e44d5297b\",\n \"state\": \"ATTACHED\",\n \"attachers\": [\n {\n \"host\": \"01b3242e-a7c8-11ea-9a01-278a0b44b8c9\",\n \"entity\": \"/vmfs/volumes/5edb3cde-ed7a2d43-f9d3-0200637d79e5/32-vm_Client_VM_Ubuntu_1404-local-1700/32-vm_Client_VM_Ubuntu_1404-local-1700.vmx\"\n }\n ]\n }\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/physical-servers": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Effective Physical Server Members that belong to this group.",
"description": "Returns Effective Physical Server Members that belong to this group.\nThis API is applicable only for Groups containing Physical Server member type.\nFor Groups containing other member types,it returns an empty list.\n",
"operationId": "GetGroupPhysicalServerMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/physical-servers?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"cursor\" : \"00361f148bdc-fe7c-4320-8ef3-594e28d57c87Iws-2\",\n \"result_count\" : 1,\n \"results\" : [\n {\n \"display_name\" : \"PhysicalServer-1\",\n \"id\" : \"420e72c9-55e7-a4f7-81bf-673a2af1a6cf\"\n }\n ]\n }\n"
}
},
"/infra/realized-state/enforcement-points/{enforcement-point-name}/ip-sets/ip-sets-nsxt/{ip-set-name}": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "Read IPSet Realized state",
"description": "Read an IPSet\n",
"operationId": "ReadIPSetRealizedState",
"parameters": [
{
"name": "enforcement-point-name",
"in": "path",
"description": "Enforcement Point Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-set-name",
"in": "path",
"description": "IPSet name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericPolicyRealizedResource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyRealizedState"
}
},
"/infra/tier-1s/{tier-1-id}/forwarding-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Routing",
"Forwarding Table"
],
"summary": "Get forwarding table from tier-1",
"description": "Get forwarding table from tier-1\n",
"operationId": "GetTier1ForwardingTable",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "component_type",
"in": "query",
"description": "Define the DR routes.",
"schema": {
"type": "string",
"enum": [
"DR_ROUTES"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_id",
"in": "query",
"description": "UUID of edge node",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "network_prefix",
"in": "query",
"description": "IPAddress or CIDR Block",
"schema": {
"type": "string",
"format": "address-or-cidr-block"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "route_source",
"in": "query",
"description": "Filter routes based on the source from which route is learned",
"schema": {
"type": "string",
"enum": [
"BGP",
"STATIC",
"CONNECTED",
"OSPF"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutingTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/forwarding-table\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"route_entries\": [\n\n {\n \"next_hop\": \"169.254.0.1\",\n \"route_type\": \"ns \",\n \"admin_distance\": 3,\n \"network\": \"25.1.0.0/16\"\n },\n {\n \"next_hop\": \"45.1.1.1\",\n \"route_type\": \"c \",\n \"admin_distance\": 0,\n \"network\": \"45.1.1.0/24\"\n },\n {\n \"next_hop\": \"169.254.0.1\",\n \"route_type\": \"ns \",\n \"admin_distance\": 3,\n \"network\": \"100.96.0.0/30\"\n },\n {\n \"next_hop\": \"169.254.0.2\",\n \"route_type\": \"c \",\n \"admin_distance\": 0,\n \"network\": \"169.254.0.0/28\"\n }\n ],\n \"count\": 4,\n \"edge_node\": \"41efeae8-58c2-11e8-993c-000c29326bac\"\n }\n ]\n}\n"
}
},
"/infra/dns-forwarder-zones": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"DNS Zones"
],
"summary": "List Dns Forwarder Zones",
"description": "Paginated list of all Dns Forwarder Zones\n",
"operationId": "ListPolicyDnsForwarderZone",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarderZoneListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dns-forwarder-zones\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\" : true,\n \"sort_by\" : \"display_name\",\n \"result_count\" : 2,\n \"results\" : [ {\n \"resource_type\" : \"PolicyDnsForwarderZone\",\n \"id\" : \"default-1\",\n \"display_name\" : \"$1\",\n \"path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"parent_path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"relative_path\" : \"default-1\",\n \"dns_domain_names\" : [ ],\n \"upstream_servers\" : [ \"3.3.3.3\", \"4.4.4.4\" ],\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517400275031,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517400275031,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 0\n }, {\n \"resource_type\" : \"PolicyDnsForwarderZone\",\n \"id\" : \"conditional-1\",\n \"display_name\" : \"$1\",\n \"path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"parent_path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"relative_path\" : \"conditional-1\",\n \"dns_domain_names\" : [ \"foo.com\" ],\n \"upstream_servers\" : [ \"1.1.1.1\", \"2.2.2.2\" ],\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517400132921,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517400132921,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 0\n } ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Locale Services"
],
"summary": "List Tier-0 locale-services",
"description": "Paginated list of all Tier-0 locale-services\n",
"operationId": "GlobalInfraListTier0LocaleServices",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServicesListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"LocaleServices\",\n \"id\": \"palo_alto\",\n \"display_name\": \"Palo Alto\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/palo_alto\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"palo_alto\",\n \"route_redistribution_types\": [ \"TIER0_STATIC\", \"TIER0_NAT\" ],\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/tier-1s": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Gateways"
],
"summary": "List Tier-1 instances",
"description": "Paginated list of all Tier-1 instances\n",
"operationId": "GlobalInfraListTier1",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier1ListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Tier1\",\n \"id\": \"cgw\",\n \"display_name\": \"/infra/tier-1s/cgw\",\n \"path\": \"/infra/tier-1s/cgw\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"cgw\",\n \"tier0_path\": \"/infra/tier-0s/vmc_prv\",\n \"force_whitelisting\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668826912,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668826912,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/effective-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "List all effective profiles for tier-1 segment port",
"description": "List all effective profiles for this segment port on given enforcement point.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1SegmentPortsEffectiveProfiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectiveProfilesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/tier1-ls/ports/port1/effective-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-1 interface group statistics information",
"description": "Get tier-1 interface group statistics information.\n",
"operationId": "GetTier1InterfaceGroupStatistics",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceGroupStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/it_t1/locale-services/1-policyconnectivity-252/interface-groups/lt1-if-1/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"members\": [\n {\n \"logical_router_port_id\": \"b109909a-81a1-4c25-bb54-ce4d0e75b6ad\",\n \"per_node_statistics\": [\n {\n \"transport_node_id\": \"2ed9af04-21c9-11e9-be65-000c2902dff7\",\n \"last_update_timestamp\": 1548965795630,\n \"rx\": {\n \"total_bytes\": 0,\n \"total_packets\": 0,\n \"dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 642,\n \"total_packets\": 13,\n \"dropped_packets\": 0\n }\n }\n ]\n }\n ]\n}\n"
}
},
"/global-infra/settings/firewall/cpu-mem-thresholds-profiles": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "List all CPU and memory thresholds profiles",
"description": "List all CPU and memory thresholds profiles.",
"operationId": "GlobalInfraListCPUMemThresholdsProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCpuMemThresholdsProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"resource_type\" : \"PolicyFirewallCpuMemThresholdsProfile\",\n \"id\" : \"default\",\n \"display_name\" : \"default-cpu-mem-thresholds-profile\",\n \"path\" : \"/infra/settings/firewall/cpu-mem-thresholds-profiles/default\",\n \"parent_path\" : \"/infra\",\n \"relative_path\" : \"default\",\n \"cpu_threshold_percentage\" : 10,\n \"mem_threshold_percentage\" : 20\n \"_create_user\" : \"admin\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/gsm/global-signatures": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "List Global IDS signatures",
"description": "List global intrusion detection signatures.\n",
"operationId": "ListGlobalIdsSignaturesPmaas",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalIdsSignatureListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/gsm/global-signatures\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"action\": \"ALERT\",\n \"signature_id\": \"12345\",\n \"enable\": true,\n \"resource_type\": \"GlobalIdsSignature\",\n \"id\": \"1\",\n \"display_name\": \"1\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/gsm/global-signatures/1\",\n \"relative_path\": \"1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"693e18fa-8a22-476b-81c1-61be4df25f95\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1590142560515,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1590142560517,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"signature_id\": \"12345\",\n \"enable\": false,\n \"resource_type\": \"GlobalIdsSignature\",\n \"id\": \"2\",\n \"display_name\": \"2\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/gsm/global-signatures/2\",\n \"relative_path\": \"2\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"b4fdaac6-7f1b-48bf-9894-72b97482bb12\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1590142586885,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1590142586886,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n],\n\"result_count\": 2,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/infra/settings/firewall/security/exclude-list?system_owned=true": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Exclusion List"
],
"summary": "Read security policy exclude list including system and user excluded members",
"description": "Read security policy exclude list including system and user excluded members.\n",
"operationId": "GetInternalFirewallExcludeList",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyExcludeList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/exclude-list?system_owned=true\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"members\": [\n \"/infra/domains/default/groups/grp1\",\n \"/infra/domains/default/groups/a8b7ddce-a5d6-11e8-a7e5-43344e310957\"\n ],\n \"resource_type\": \"PolicyExcludeList\",\n \"id\": \"security-policy\",\n \"display_name\": \"/infra/settings/firewall/security/exclude-list\",\n \"path\": \"/infra/settings/firewall/security/exclude-list\",\n \"relative_path\": \"security-policy\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1552908666342,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1553087794966,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given object is a member",
"description": "Get policy groups for which the given object is a member.\nIn Federation environment, if the given object is a global entity\n(eg: global segment) and if the entity is not stretched to the site\nspecified in the enforcement_point_path parameter,then the following is returned:-\n1)If the entity is a member of any global group and that group is stretched\n to the enforcement_point_path site,then the API returns an empty list.\n2)If the entity is not a member of any global group,this API returns\n an 'invalid path' error message.\n3)If both the entity and its corresponding groups are stretched to the\n enforcement_point_path site , then the API returns the groups list.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGroupsForObject",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "intent_path",
"in": "query",
"description": "String path of the intent object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/group-associations?intent_path=/infra/segment/s1&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n }\n }\n ]\n}\n"
}
},
"/infra/identity-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given Identity Group is a member",
"description": "Get policy groups for which the given Identity Group is a member.\n",
"operationId": "GetGroupsForIdentityGroup",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "identity_group_external_id",
"in": "query",
"description": "Identity Group external ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/identity-group-associations?identity_group_external_id=564de333-15ac-de52-da90-974fe099a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/vifs": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Security",
"Groups",
"Group Members"
],
"summary": "Get Virtual Network Interface instances that belong to this Group",
"description": "Get Virtual Network Interface instances that belong to this Group.\nThis API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types.\nFor Groups containing other member types,an empty list is returned. target_id in response\nis external_id of VirtualNetworkInterface or VirtualMachine.\n",
"operationId": "GetVpcGroupVIFMembers",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualNetworkInterfaceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/groups/g1/members/vifs?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyVpcGroup",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"external_id\": \"564dda4e-bc05-061c-dac7-7a314e0e0c9c-4000\",\n \"owner_vm_id\": \"1778a2b0-7f9b-4c64-806c-bc13d6d60762\",\n \"owner_vm_type\": \"REGULAR\",\n \"host_id\": \"28477562-ea6f-11e9-9c84-f98983786a98\",\n \"vm_local_id_on_host\": \"1\",\n \"device_key\": \"4000\",\n \"device_name\": \"Network adapter 1\",\n \"mac_address\": \"00:0c:29:0e:0c:9c\",\n \"ip_address_info\": [\n {\n \"source\": \"VM_TOOLS\",\n \"ip_addresses\": [\n \"10.170.66.155\",\n \"fd01:3:4:2825:c5dc:25a5:fbb9:6762\",\n \"fd01:3:4:2825:2c49:a400:48df:23dd\",\n \"fd01:3:4:2825:34ca:5670:96e0:6edf\",\n \"fd01:3:4:2825:d9e4:5e51:6df6:c93e\",\n \"fd01:3:4:2825:b002:86da:30d4:1030\",\n \"fd01:3:4:2825:20c:29ff:fe0e:c9c\",\n \"fe80::20c:29ff:fe0e:c9c\",\n \"fd01:3:4:2825:eddf:5879:67d5:6293\",\n \"fd01:3:4:2825:f027:6316:8de5:3a29\"\n ]\n }\n ],\n \"resource_type\": \"VirtualNetworkInterface\",\n \"display_name\": \"Network adapter 1\",\n \"_last_sync_time\": 0\n }\n],\n\"result_count\": 1,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Get IPSec VPN Session",
"description": "Get IPSec VPN session with senstive data for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1VpnIPSecVpnSessionWithSensitiveData",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1?action=show_sensitive_data\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyBasedIPSecVpnSession\",\n \"description\": \"Policy based vpn session 1\",\n \"display_name\": \"pbs-1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"psk\" : \"test\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"rules\" : [ {\n \"resource_type\": \"IPSecVpnRule\",\n \"id\": \"custom-rule-1\",\n \"path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1/rules/custom-rule-1\",\n \"parent_path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\",\n \"relative_path\": \"custom-rule-1\",\n \"sources\": [\n {\n \"subnet\" : \"10.0.2.0/24\"\n },\n {\n \"subnet\" : \"10.0.1.0/24\"\n }\n ],\n \"destinations\" : [\n {\n \"subnet\" : \"10.1.1.0/24\"\n }\n ],\n \"enabled\" : true,\n \"logged\" : true,\n \"action\": \"PROTECT\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n } ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 0\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"IP Management"
],
"summary": "List VPC Subnet ip allocations",
"description": "List all the ip allocations for a VPC Subnet.\n",
"operationId": "ListVpcSubnetIpAllocations",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressAllocationListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/subnets/subnet-1/ip-pools/pool-1/ip-allocations\n",
"x-vmw-nsx-module": "PolicyVpcSubnetIpam",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"IpAddressAllocation\",\n \"id\": \"ipallocation-1\",\n \"display_name\": \"ip-1-allocation\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ip-pools/pool-1/ip-allocations/ipallocation-1\",\n \"relative_path\": \"ip-1-allocation\",\n \"parent_path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ip-pools/pool-1\",\n \"marked_for_delete\": false,\n \"allocation_ip\": \"10.0.0.5\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1543966814544,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1543966814544,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"IpAddressAllocation\",\n \"id\": \"ipallocation-2\",\n \"display_name\": \"ip-2-allocation\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ip-pools/pool-1/ip-allocations/ipallocation-2\",\n \"relative_path\": \"ip-2-allocation\",\n \"parent_path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ip-pools/pool-1\",\n \"marked_for_delete\": false,\n \"allocation_ip\": \"10.0.0.6\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1543966814545,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1543966814544,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-1 interface statistics information",
"description": "Get tier-1 interface statistics information.\n",
"operationId": "GetTier1InterfaceStatistics",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/it_t1/locale-services/1-policyconnectivity-252/interfaces/lt1-if-1/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_router_port_id\": \"b109909a-81a1-4c25-bb54-ce4d0e75b6ad\",\n \"per_node_statistics\": [\n {\n \"transport_node_id\": \"2ed9af04-21c9-11e9-be65-000c2902dff7\",\n \"last_update_timestamp\": 1548965795630,\n \"rx\": {\n \"total_bytes\": 0,\n \"total_packets\": 0,\n \"dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 642,\n \"total_packets\": 13,\n \"dropped_packets\": 0\n }\n }\n ]\n}\n"
}
},
"/infra/pod-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given pod is a member",
"description": "Get policy groups for which the given pod is a member.\n",
"operationId": "GetGroupsForContainerApplicationInstance",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "pod_id",
"in": "query",
"description": "ContainerApplicationInstance",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/pod-group-associations?pod_id=64dde333-15ac-de52-da90-974de459a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions",
"Summary"
],
"summary": "Get IPSec VPN Session Summary",
"description": "Summarized view of all tier-0 IPSec VPN sessions for a specified service.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier0VpnIpsecVpnSessionSummary",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIpsecVpnIkeServiceSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-0s/TLR0_LR/ipsec-vpn-services/test-ipsec-svc/summary\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": "{\n \"ipsec_vpn_service_path\": \"/infra/tier-0s/TLR0_LR/ipsec-vpn-services/test-ipsec-svc\",\n \"display_name\": \"test-ipsec-svc\",\n \"session_summary\": {\n \"established_sessions\": 0,\n \"failed_sessions\": 1,\n \"degraded_sessions\": 0,\n \"total_sessions\": 1\n },\n \"aggregate_traffic_counters\": {\n \"packets_in\": 0,\n \"packets_out\": 0,\n \"bytes_in\": 0,\n \"bytes_out\": 0,\n \"dropped_packets_in\": 0,\n \"dropped_packets_out\": 0\n },\n \"traffic_summary_per_session\": [\n {\n \"traffic_counters\": {\n \"packets_in\": 0,\n \"packets_out\": 0,\n \"bytes_in\": 0,\n \"bytes_out\": 0,\n \"dropped_packets_in\": 0,\n \"dropped_packets_out\": 0\n },\n \"ipsec_vpn_session\": {\n \"target_id\": \"/infra/tier-1s/TLR0_LR/ipsec-vpn-services/test-ipsec-svc/sessions/2a30271f-a856-4168-9097-b5955f40d446\",\n \"target_type\": \"IPSecVPNSession\",\n \"is_valid\": true\n }\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/context-profiles/custom-attributes/default": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Retrieves custom attribute values for given attribute key",
"description": "This API lists all the custom attribute values defined in the system for the attribute_key\nmentioned as part of the url.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetCustomAttribute",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attribute_key",
"in": "query",
"description": "Fetch attributes and sub-attributes for the given attribute key",
"schema": {
"type": "string"
}
},
{
"name": "attribute_source",
"in": "query",
"description": "Source of the attribute, System Defined or custom",
"schema": {
"type": "string",
"default": "SYSTEM",
"enum": [
"ALL",
"CUSTOM",
"SYSTEM"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes/default?attribute_key=DOMAIN_NAME\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.office365.com\", \"*.azure.com\"\n ],\n \"datatype\":\"STRING\"\n}\n"
},
"post": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Adds/Removes custom attribute values from list",
"description": "This API adds/removes custom attribute values from list for a given attribute key. The values in the \nrequest will be added or removed from the existing list.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraAddRemoveCustomAttribute",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Add or Remove Custom Context Profile Attribute values.",
"required": true,
"schema": {
"type": "string",
"enum": [
"add",
"remove"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyCustomAttributes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes/default?action=add\n{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.customdomainname5.com\", \"*.customdomainname6.com\"\n ],\n \"datatype\":\"STRING\"\n }\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "200 OK\n",
"x-codegen-request-body-name": "PolicyCustomAttributes"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Update custom attribute value list for given attribute key.",
"description": "This API updates custom attribute value list for given key in the request. This replaces the \nexisting list with the list provided in the request\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchCustomAttribute",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyCustomAttributes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes/default\n{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.customdomainname1.com\", \"*.customdomainname2.com\"\n ],\n \"datatype\":\"STRING\"\n }\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "200 OK\n",
"x-codegen-request-body-name": "PolicyCustomAttributes"
}
},
"/global-infra/domains/{domain-id}/groups/{group-id}/members/consolidated-effective-ip-addresses": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get consolidated effective IPAddress translated from this group across site",
"description": "Returns the consolidated effective IP address members of the specified Group. This is applicable in the case of a\nfederated environment. The response includes a site-wise list of static and dynamically translated effective IP\naddress members. If the group evaluation on a site is empty, the response will contain the site-id with empty list.\nIf a group is a reference group on a site, then its consolidated effective IP response will contain the effective IPs\nfrom other sites, and the response will contain an empty list of IPs for the sites where is it a reference group.\n\nThis API is applicable only for Global Groups that contain (either directly or via nesting) VirtualMachine,\nVIF, Segment, SegmentPort, or IPSet member types. Please use the cursor value in the response to fetch the next page.\nIf there is no cursor value in the response, it indicates that it is the last page of results for the query.\n",
"operationId": "GlobalInfraGetConsolidatedEffectiveIPMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "ip_filter",
"in": "query",
"description": "IP address, range, or subnet",
"schema": {
"type": "string",
"format": "address-or-block-or-range"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "site_id",
"in": "query",
"description": "UUID of the site from which the effective IP addresses are to be fetched\n",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolidatedEffectiveIPAddressMemberListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "Group demo1 have dynamic criteria based on vm name contains 'vm' and 2 static IPs\n\"fd01:0:101:2600:20c:29ff:fe23:eef3\",\"25.1.1.4/30\".\n\nRequest for Group in Federation environment on Paris LM:\nGET https://{{paris-site-ip}}/policy/api/v1/global-infra/domains/default/groups/demo1/members/consolidated-effective-ip-addresses?enforcement_point_path=/global-infra/sites/Paris/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"site_id\": \"e977e929-255e-41c0-a938-a35d12f860ee\",\n \"effective_ips\": [\n \"fd01:0:101:2600:20c:29ff:fe23:eef3\",\n \"25.1.1.4/30\",\n \"10.160.8.45\",\n \"10.160.16.77\"\n ]\n },\n {\n \"site_id\": \"210d7017-5dca-4901-bfcc-c63928215160\",\n \"effective_ips\": [\n \"fd01:0:101:2600:20c:29ff:fe23:eef3\",\n \"25.1.1.4/30\",\n \"10.160.10.118\",\n \"10.160.27.172\"\n ]\n },\n {\n \"site_id\": \"fa8be70f-b592-4cb1-add9-b89ccdfd3ee3\",\n \"effective_ips\": [\n \"fd01:0:101:2600:20c:29ff:fe23:eef3\",\n \"25.1.1.4/30\",\n \"10.160.15.134\",\n \"10.160.26.223\"\n ]\n }\n ],\n \"cursor\": \"7806177147493-0\"\n}\n"
}
},
"/observability/flow-details": {
"get": {
"tags": [
"Federation",
"Observability"
],
"summary": "Get monitoring info",
"description": "Provides federation monitoring information, which includes all\nconfig flows originating from the site where API is invoked.\n",
"operationId": "GetFlowDetails",
"parameters": [
{
"name": "site_path",
"in": "query",
"description": "Policy path of the Site object",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonitoringInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<global-manager>/global-manager/api/v1/observability/flow-details\nGET https://<local-manager>/policy/api/v1/observability/flow-details\n",
"x-vmw-nsx-module": "FederationObservability",
"x-vmw-nsx-example-response": "On Global Manager\n{\n \"monitoring_info\": [{\n \"id\": \"rrrrrr-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"GM_TO_LM\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"gm2lm.transmitter.delta\",\n \"namespace\": \"ar-queues\"\n },\n {\n \"max_size\": 1000,\n \"current_size\": 200,\n \"name\": \"gm2lm.receiver.delta\",\n \"namespace\": \"ar-queues\"\n },\n ],\n\n \"cross_site_flow_info\": {\n \"status\": \"GOOD\",\n \"to_site_id\": \"36021bd5-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"to_site_path\": \"/global-infra/sites/Newyork\",\n \"from_site_id\": \"ececa019-3601-47dc-b92e-f21f52b34f6f\",\n \"from_site_path\": \"/global-infra/global-managers/LondonGM\",\n \"latency_millis\": 123,\n \"latency_measured_ts\": 1590336614947,\n \"last_full_sync\": {\n \"status\": \"COMPLETED\",\n \"id\": \"f6fda71a-d5f2-4000-8677-deaafd80641e\",\n \"reason_code\": \"10010\",\n \"reason\": \"Site onboarded\",\n \"stage\": \"COMPLETED\",\n \"data_streaming_from_source_progress\": \"Sending resources of type COMMUNICATION_MAP\",\n \"data_streaming_from_source_start_time\": 1590335604947,\n \"data_streaming_from_source_end_time\": 1590336604947,\n \"receiver_state\": \"COMPLETED\",\n \"receiver_start_time\": 1590336614947,\n \"receiver_end_time\": 1590336714947,\n \"start_time\": 1590335604947,\n \"end_time\": 1590435604947,\n \"errors\": {},\n \"warnings\": {}\n }\n }\n },\n {\n \"id\": \"asarrr-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"GM_TO_LM\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"gm2lm.transmitter.delta\",\n \"namespace\": \"ar-queues\"\n },\n {\n \"max_size\": 1000,\n \"current_size\": 200,\n \"name\": \"gm2lm.receiver.delta\",\n \"namespace\": \"ar-queues\"\n },\n ],\n\n \"cross_site_flow_info\": {\n \"status\": \"GOOD\",\n \"to_site_id\": \"aa021bd5-9ebc-46e0-9d7a-5a4fa8bb3111\",\n \"to_site_path\": \"/global-infra/sites/Paris\",\n \"from_site_id\": \"ececa019-3601-47dc-b92e-f21f52b34f6f\",\n \"from_site_path\": \"/global-infra/global-managers/LondonGM\",\n \"latency_millis\": 123,\n \"latency_measured_ts\": 1590336614947,\n \"last_full_sync\": {\n \"status\": \"COMPLETED\",\n \"id\": \"f6fda71a-d5f2-4000-8677-deaafd80641e\",\n \"reason_code\": \"10010\",\n \"reason\": \"Site onboarded\",\n \"stage\": \"COMPLETED\",\n \"data_streaming_from_source_progress\": \"Sending resources of type COMMUNICATION_MAP\",\n \"data_streaming_from_source_start_time\": 1590335604947,\n \"data_streaming_from_source_end_time\": 1590336604947,\n \"receiver_state\": \"COMPLETED\",\n \"receiver_start_time\": 1590336614947,\n \"receiver_end_time\": 1590336714947,\n \"start_time\": 1590335604947,\n \"end_time\": 1590435604947,\n \"errors\": {},\n \"warnings\": {}\n }\n }\n },\n {\n \"id\": \"rrbbr-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"LM_TO_GM\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"lm2gm.transmitter.delta\",\n \"namespace\": \"ar-queues\"\n },\n {\n \"max_size\": 1000,\n \"current_size\": 200,\n \"name\": \"lm2gm.receiver.delta\",\n \"namespace\": \"ar-queues\"\n },\n ],\n\n \"cross_site_flow_info\": {\n \"status\": \"GOOD\",\n \"to_site_id\": \"ececa019-3601-47dc-b92e-f21f52b34f6f\",\n \"to_site_path\": \"/global-infra/global-managers/LondonGM\",\n \"from_site_id\": \"aa021bd5-9ebc-46e0-9d7a-5a4fa8bb3111\",\n \"from_site_path\": \"/global-infra/sites/Paris\",\n \"latency_millis\": 125\n }\n },\n {\n \"id\": \"ca00-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"LM_TO_GM\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"lm2gm.transmitter.delta\",\n \"namespace\": \"ar-queues\"\n },\n {\n \"max_size\": 1000,\n \"current_size\": 200,\n \"name\": \"lm2gm.receiver.delta\",\n \"namespace\": \"ar-queues\"\n },\n ],\n\n \"cross_site_flow_info\": {\n \"status\": \"GOOD\",\n \"to_site_id\": \"ececa019-3601-47dc-b92e-f21f52b34f6f\",\n \"to_site_path\": \"/global-infra/global-managers/NewyorkGM\",\n \"from_site_id\": \"BB021bd5-9ebc-46e0-9d7a-5a4fa8bb3155\",\n \"from_site_path\": \"/global-infra/sites/Newyork\",\n \"latency_millis\": 120\n \"latency_measured_ts\": 1590336614947,\n }\n },\n {\n \"id\": \"cab10-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"GM_WORK_QUEUE\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"gm-work-queue\",\n \"namespace\": \"gm\"\n }\n ]\n },\n {\n \"id\": \"dea0-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"GM_DELETE_QUEUE\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"gm-delete-queue-1\",\n \"namespace\": \"gm\"\n }\n ]\n }\n ]\n}\n\nOn Local Manager\n{\n \"monitoring_info\": [\n {\n \"id\": \"we11-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"GM_TO_LM\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"gm2lm.transmitter.delta\",\n \"namespace\": \"ar-queues\"\n },\n {\n \"max_size\": 1000,\n \"current_size\": 200,\n \"name\": \"gm2lm.receiver.delta\",\n \"namespace\": \"ar-queues\"\n },\n ],\n\n \"cross_site_flow_info\": {\n \"status\": \"GOOD\",\n \"to_site_id\": \"aa021bd5-9ebc-46e0-9d7a-5a4fa8bb3111\",\n \"to_site_path\": \"/global-infra/sites/Paris\",\n \"from_site_id\": \"ececa019-3601-47dc-b92e-f21f52b34f6f\",\n \"from_site_path\": \"/global-infra/global-managers/LondonGM\",\n \"latency_millis\": 123,\n \"latency_measured_ts\": 1590336614947,\n \"last_full_sync\": {\n \"status\": \"COMPLETED\",\n \"id\": \"f6fda71a-d5f2-4000-8677-deaafd80641e\",\n \"reason_code\": \"10010\",\n \"reason\": \"Site onboarded\",\n \"stage\": \"COMPLETED\",\n \"data_streaming_from_source_progress\": \"Sending resources of type COMMUNICATION_MAP\",\n \"data_streaming_from_source_start_time\": 1590335604947,\n \"data_streaming_from_source_end_time\": 1590336604947,\n \"receiver_state\": \"COMPLETED\",\n \"receiver_start_time\": 1590336614947,\n \"receiver_end_time\": 1590336714947,\n \"start_time\": 1590335604947,\n \"end_time\": 1590435604947,\n \"errors\": {},\n \"warnings\": {}\n }\n }\n },\n {\n \"id\": \"fg12-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"LM_TO_GM\",\n \"queue_info\": [\n {\n \"max_size\": 1000,\n \"current_size\": 100,\n \"name\": \"lm2gm.transmitter.delta\",\n \"namespace\": \"ar-queues\"\n },\n {\n \"max_size\": 1000,\n \"current_size\": 200,\n \"name\": \"lm2gm.receiver.delta\",\n \"namespace\": \"ar-queues\"\n },\n ],\n\n \"cross_site_flow_info\": {\n \"status\": \"GOOD\",\n \"to_site_id\": \"ececa019-3601-47dc-b92e-f21f52b34f6f\",\n \"to_site_path\": \"/global-infra/global-managers/LondonGM\",\n \"from_site_id\": \"aa021bd5-9ebc-46e0-9d7a-5a4fa8bb3111\",\n \"from_site_path\": \"/global-infra/sites/Paris\",\n \"latency_millis\": 125,\n \"latency_measured_ts\": 1590336614947,\n }\n },\n {\n \"id\": \"ff10-9ebc-46e0-9d7a-5a4fa8bb3802\",\n \"flow_type\":\"LM_TO_LM\",\n \"cross_site_flow_info\": {\n \"status\": \"GOOD\",\n \"to_site_id\": \"aa021bd5-9ebc-46e0-9d7a-5a4fa8bb3111\", // To NewYork (LM doesn't have site paths)\n \"from_site_id\": \"ececa019-3601-47dc-b92e-f21f52b34f6f\",\n \"latency_millis\": 123,\n \"latency_measured_ts\": 1590336614947,\n }\n }\n ]\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Get Port QoS Profile Binding Map",
"description": "API will get Port QoS Profile Binding Map.\n",
"operationId": "GlobalInfraGetPortQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Update Port QoS Profile Binding Map",
"description": "API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "GlobalInfraUpdatePortQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n{\n \"resource_type\":\" PortQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"description\":\"\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortQoSProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Delete Port QoS Profile Binding Profile",
"description": "API will delete Port QoS Profile Binding Profile.",
"operationId": "GlobalInfraDeletePortQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Create Port QoS Profile Binding Map",
"description": "API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "GlobalInfraPatchPortQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n{\n \"resource_type\":\" PortQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-codegen-request-body-name": "PortQoSProfileBindingMap"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Static Routes"
],
"summary": "List VPC Static Routes",
"description": "Paginated list of all VPC Static Routes\n",
"operationId": "ListVpcStaticRoutes",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutesListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes\n",
"x-vmw-nsx-module": "PolicyVpcStaticRoutes",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"StaticRoutes\",\n \"id\": \"static-route-1\",\n \"display_name\": \"static-route-1\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/static-routes/static-route-1\",\n \"parent_path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1\",\n \"relative_path\": \"static-route-1\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"network\": \"45.1.1.0/24\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516750267338,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516750267338,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/dhcp-server-configs/{config-id}/stats?action=reset": {
"post": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Reset DHCP server statistics counters",
"description": "Reset DHCP statistics counters of a DHCP server represented by the\nconnectivity_path and the enforecement_point_path where the\ndhcp-server-config was applied to. The connectivity_path can be the Tier0\npath, Tier1 path or a segment path. If the given Tier0/1 or Segment has\nDHCP server applied, the resetting will succeed and the DHCP statistics\ncounters will be reset to 0. But if it has no DHCP server applied, the\nreseting will fail with proper error message.\n",
"operationId": "ResetDhcpServerStats",
"parameters": [
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/stats?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{}\n"
}
},
"/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer SSL Profiles",
"Load Balancer Client SSL Profiles"
],
"summary": "Read LBClientSslProfile",
"description": "Read a LBClientSslProfile.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "ReadLBClientSslProfile",
"parameters": [
{
"name": "lb-client-ssl-profile-id",
"in": "path",
"description": "LBClientSslProfile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBClientSslProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/lb-client-ssl-profiles/default-balanced-client-ssl-profile\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"cipher_group_label\": \"BALANCED\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"session_cache_timeout\": 300,\n \"prefer_server_ciphers\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBClientSslProfile\",\n \"id\": \"default-balanced-client-ssl-profile\",\n \"display_name\": \"default-balanced-client-ssl-profile\",\n \"path\": \"/infra/lb-client-ssl-profiles/default-balanced-client-ssl-profile\",\n \"relative_path\": \"default-balanced-client-ssl-profile\",\n \"parent_path\": \"/infra/lb-client-ssl-profiles/default-balanced-client-ssl-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1543304450941,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1543304450941,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer SSL Profiles",
"Load Balancer Client SSL Profiles"
],
"summary": "Create or update a LBClientSslProfile",
"description": "If a LBClientSslProfile with the lb-client-ssl-profile-id is not already\npresent, create a new LBClientSslProfile. If it already exists, update the\nLBClientSslProfile. This is a full replace.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "UpdateLBClientSslProfile",
"parameters": [
{
"name": "lb-client-ssl-profile-id",
"in": "path",
"description": "LBClientSslProfile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBClientSslProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBClientSslProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/lb-client-ssl-profiles/testClientSslProfile\n{\n \"resource_type\": \"LBClientSslProfile\",\n \"cipher_group_label\":\"BALANCED\",\n \"session_cache_enabled\":false\n}\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LBClientSslProfile\",\n \"cipher_group_label\": \"CUSTOM\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"session_cache_timeout\": 300,\n \"prefer_server_ciphers\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBClientSslProfile\",\n \"id\": \"testClientSslProfile\",\n \"display_name\": \"testClientSslProfile\",\n \"path\": \"/infra/lb-client-ssl-profiles/testClientSslProfile\",\n \"relative_path\": \"testClientSslProfile\",\n \"parent_path\": \"/infra/lb-client-ssl-profiles/testClientSslProfile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1543420840714,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1543420840714,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "LBClientSslProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer SSL Profiles",
"Load Balancer Client SSL Profiles"
],
"summary": "Delete LBClientSslProfile and all the entities contained by this\nLBClientSslProfile\n",
"description": "Delete the LBClientSslProfile along with all the entities contained\nby this LBClientSslProfile.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "DeleteLBClientSslProfile",
"parameters": [
{
"name": "lb-client-ssl-profile-id",
"in": "path",
"description": "LBClientSslProfile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force delete the resource even if it is being used somewhere\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/lb-client-ssl-profiles/mySslProfile\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer SSL Profiles",
"Load Balancer Client SSL Profiles"
],
"summary": "Create or update a LBClientSslProfile",
"description": "If a LBClientSslProfile with the lb-client-ssl-profile-id is not already\npresent, create a new LBClientSslProfile. If it already exists, update the\nLBClientSslProfile. This is a full replace.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "PatchLBClientSslProfile",
"parameters": [
{
"name": "lb-client-ssl-profile-id",
"in": "path",
"description": "LBClientSslProfile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBClientSslProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/lb-client-ssl-profiles/myClientSslProfile\n{\n \"resource_type\": \"LBClientSslProfile\",\n \"cipher_group_label\":\"BALANCED\",\n \"session_cache_enabled\":false\n}\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "LBClientSslProfile"
}
},
"/infra/drafts/{draft-id}/aggregated": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Get an aggregated configuration for the draft",
"description": "Get an aggregated configuration that will get applied onto current\nconfiguration during publish of this draft.\nThe response is a hierarchical payload containing the aggregated\nconfiguration differences from the latest auto draft till the specified draft.\n",
"operationId": "GetAggregatedConfigurationToBePublishedForDraft",
"parameters": [
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Infra"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft/aggregated\n",
"x-vmw-nsx-module": "PolicyDraft",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Infra\",\n \"id\": \"infra\",\n \"display_name\": \"infra\",\n \"path\": \"/infra\",\n \"children\": [\n {\n \"children\": [\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-1\",\n \"display_name\": \"app-section-1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 1,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"target_type\": \"Domain\",\n \"resource_type\": \"ChildResourceReference\",\n \"id\": \"default\",\n \"marked_for_delete\": false,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Get IPSec VPN service list result",
"description": "Get paginated list of all IPSec VPN services\nfor a given locale service under Tier-1.\n\n
\nThis API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n",
"operationId": "ListTier1IPSecVpnServices",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services\n",
"x-vmw-nsx-module": "PolicyIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"IPSecVpnService\",\n \"path\" : \"/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default\",\n \"enabled\" : false,\n \"bypass_rules\" : [],\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/prefix-lists": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Prefix List"
],
"summary": "List prefix lists",
"description": "Paginated list of all prefix lists\n",
"operationId": "GlobalInfraListPrefixLists",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrefixListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/prefix-lists\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PrefixList\",\n \"id\": \"to-onprem\",\n \"display_name\": \"/infra/tier-0s/vmc/prefix-lists/to-onprem\",\n \"path\": \"/infra/tier-0s/vmc/prefix-lists/to-onprem\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"to-onprem\",\n \"marked_for_delete\": false,\n \"prefixes\": [\n {\n \"action\": \"PERMIT\",\n \"network\": \"30.1.1.0/24\"\n },\n {\n \"action\": \"DENY\",\n \"network\": \"10.1.1.0/24\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1525754971782,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1525755003657,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/segments/{segment-id}/segment-security-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "List infra segment security profile binding maps",
"description": "API will list all segment security profile binding maps.\n",
"operationId": "GlobalInfraListInfraSegmentSecurityProfileBindings",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/segment-security-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentSecurityProfileBindingMap\",\n \"id\": \"segment_security_binding_map_1\",\n \"display_name\": \"segment_security_binding_map_1\",\n \"path\": \"/infra/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\",\n \"parent_path\": \"/infra/segments/segment_1\",\n \"relative_path\": \"segment_security_binding_map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539129491798,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129739799,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"DHCP"
],
"summary": "List all VPC Subnet DHCP static bindings",
"description": "Paginated list of all VPC Subnet DHCP static binding instances\n",
"operationId": "ListVpcSubnetDhcpStaticBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/dhcp-static-binding-configs\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"binding-1\",\n \"display_name\": \"binding-1\",\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/subnets/subnet-1/dhcp-static-binding-configs/binding-1\",\n \"relative_path\": \"binding-1\",\n \"parent_path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/subnets/subnet-1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595467058,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/sha/appliances/latency/status": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Heatmap"
],
"summary": "Get the details of latency status for all appliances\n",
"description": "Get the details of latency status for all appliances\n",
"operationId": "GetAllApplianceLatencyData",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplianceLatencyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sha/appliances/latency/status\n",
"x-vmw-nsx-module": "PolicyShaAppliance",
"x-vmw-nsx-example-response": "{\n \"result_count\": 3,\n \"results\": [\n {\n \"id\": \"72e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"name\": \"nsxmanager-15702468-1\",\n \"latency_data\": [\n {\n \"source_node_ip\": \"10.92.111.33\",\n \"destination_node_id\": \"22e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"destination_node_name\": \"nsxmanager-15702468-2\",\n \"destination_node_ip\": \"10.92.111.34\",\n \"rtt_min\": 0.180,\n \"rtt_avg\": 0.396,\n \"rtt_max\": 1.003,\n \"rtt_mdev\": 0.350,\n \"status\": \"UP\",\n \"packet_transmitted\": 4,\n \"packet_received\": 4,\n \"packet_loss_percent\": \"0%\",\n \"total_time\": 3049,\n },\n {\n \"source_node_ip\": \"10.92.111.33\",\n \"destination_node_id\": \"42e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"destination_node_name\": \"nsxmanager-15702468-3\",\n \"destination_node_ip\": \"10.92.111.35\",\n \"rtt_min\": 0.180,\n \"rtt_avg\": 0.396,\n \"rtt_max\": 1.003,\n \"rtt_mdev\": 0.350,\n \"status\": \"UP\",\n \"packet_transmitted\": 4,\n \"packet_received\": 4,\n \"packet_loss_percent\": \"0%\",\n \"total_time\": 3049,\n }\n ]\n },\n {\n \"id\": \"22e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"name\": \"nsxmanager-15702468-2\",\n \"latency_data\": [\n {\n \"source_node_ip\": \"10.92.111.34\",\n \"destination_node_id\": \"72e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"destination_node_name\": \"nsxmanager-15702468-1\",\n \"destination_node_ip\": \"10.92.111.33\",\n \"rtt_min\": 0.180,\n \"rtt_avg\": 0.396,\n \"rtt_max\": 1.003,\n \"rtt_mdev\": 0.350,\n \"status\": \"UP\",\n \"packet_transmitted\": 4,\n \"packet_received\": 4,\n \"packet_loss_percent\": \"0%\",\n \"total_time\": 3049,\n },\n {\n \"source_node_ip\": \"10.92.111.34\",\n \"destination_node_id\": \"42e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"destination_node_name\": \"nsxmanager-15702468-3\",\n \"destination_node_ip\": \"10.92.111.35\",\n \"rtt_min\": 0.180,\n \"rtt_avg\": 0.396,\n \"rtt_max\": 1.003,\n \"rtt_mdev\": 0.350,\n \"status\": \"UP\",\n \"packet_transmitted\": 4,\n \"packet_received\": 4,\n \"packet_loss_percent\": \"0%\",\n \"total_time\": 3049,\n }\n ]\n },\n {\n \"id\": \"42e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"name\": \"nsxmanager-15702468-3\",\n \"latency_data\": [\n {\n \"source_node_ip\": \"10.92.111.35\",\n \"destination_node_id\": \"72e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"destination_node_name\": \"nsxmanager-15702468-1\",\n \"destination_node_ip\": \"10.92.111.33\",\n \"rtt_min\": 0.180,\n \"rtt_avg\": 0.396,\n \"rtt_max\": 1.003,\n \"rtt_mdev\": 0.350,\n \"status\": \"UP\",\n \"packet_transmitted\": 4,\n \"packet_received\": 4,\n \"packet_loss_percent\": \"0%\",\n \"total_time\": 3049,\n },\n {\n \"source_node_ip\": \"10.92.111.35\",\n \"destination_node_id\": \"22e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"destination_node_name\": \"nsxmanager-15702468-2\",\n \"destination_node_ip\": \"10.92.111.34\",\n \"rtt_min\": 0.180,\n \"rtt_avg\": 0.396,\n \"rtt_max\": 1.003,\n \"rtt_mdev\": 0.350,\n \"status\": \"UP\",\n \"packet_transmitted\": 4,\n \"packet_received\": 4,\n \"packet_loss_percent\": \"0%\",\n \"total_time\": 3049,\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Get Port QoS Profile Binding Map",
"description": "API will get Port QoS Profile Binding Map.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraPortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Update Port QoS Profile Binding Map",
"description": "API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateInfraPortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n{\n \"resource_type\":\" PortQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortQoSProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Delete Port QoS Profile Binding Profile",
"description": "API will delete Port QoS Profile Binding Profile.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteInfraPortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Create Port QoS Profile Binding Map",
"description": "API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchInfraPortQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-qos-profile-binding-map-id",
"in": "path",
"description": "Port QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\n{\n \"resource_type\":\" PortQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-codegen-request-body-name": "PortQoSProfileBindingMap"
}
},
"/global-infra/metadata-proxies/{metadata-proxy-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Metadata Proxy",
"Status"
],
"summary": "Get metadata proxy status",
"description": "Get metadata proxy status",
"operationId": "GlobalInfraReadMetadataProxyStatistics",
"parameters": [
{
"name": "metadata-proxy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "segment_path",
"in": "query",
"description": "String Path of the segment which is associated with this metadata proxy",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyMetadataProxyStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/metadata-proxies/p1/statistics?segment_path=/infra/segments/md-proxy-seg1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyMetadataProxy",
"x-vmw-nsx-example-response": "{\n \"metadata_proxy_path\": \"/infra/metadata-proxies/p1\",\n \"timestamp\": 1591854737938,\n \"statistics\": [\n {\n \"segment_path\": \"/infra/segments/md-proxy-seg1\",\n \"requests_from_clients\": 0,\n \"responses_to_clients\": 0,\n \"requests_to_nova_server\": 0,\n \"succeeded_responses_from_nova_server\": 0,\n \"error_responses_from_nova_server\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/profiles/{profile-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "Get IDS profile.",
"description": "Read intrusion detection profile\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIdsProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyIDS"
},
"put": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "create or update IDS profile",
"description": "Update intrusion detection profile.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdateIdsProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/test-profile\n\n {\n \"profile_severity\" : [ \"CRITICAL\" ],\n \"criteria\" : [ {\n \"filter_name\" : \"CVSS\",\n \"filter_value\" : [ \"MEDIUM\" ],\n \"resource_type\" : \"IdsProfileFilterCriteria\"\n } ],\n \"resource_type\" : \"IdsProfile\",\n \"marked_for_delete\" : false,\n \"overridden\" : false\n }\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"profile_severity\" : [ \"CRITICAL\" ],\n \"criteria\": [\n {\n \"filter_name\": \"CVSS\",\n \"filter_value\": [\n \"MEDIUM\"\n ],\n \"resource_type\": \"IdsProfileFilterCriteria\"\n }\n ],\n \"resource_type\": \"IdsProfile\",\n \"id\": \"test-profile\",\n \"display_name\": \"test-profile\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/profiles/test-profile\",\n \"relative_path\": \"test-profile\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"4e874f1e-62f7-40f5-93dc-65b915a557a9\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1586765213098,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1586765213102,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n",
"x-codegen-request-body-name": "IdsProfile"
},
"delete": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "Delete IDS profile",
"description": "Delete intrusion detection profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteIdsProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/test-profile\n",
"x-vmw-nsx-module": "PolicyIDS"
},
"patch": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "Patch IDS profile",
"description": "Patch intrusion detection system profile.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchIdsProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/test-ids-profile\n\n {\n \"profile_severity\" : [\n \"CRITICAL\"\n ],\n \"criteria\" : [ {\n \"filter_name\" : \"CVSS\",\n \"filter_value\" : [ \"CRITICAL\" ],\n \"resource_type\" : \"IdsProfileFilterCriteria\"\n }, {\n \"operator\" : \"AND\",\n \"resource_type\" : \"IdsProfileConjunctionOperator\"\n }, {\n \"filter_name\" : \"PRODUCT_AFFECTED\",\n \"filter_value\" : [ \"NONE\" ],\n \"resource_type\" : \"IdsProfileFilterCriteria\"\n }, {\n \"operator\" : \"AND\",\n \"resource_type\" : \"IdsProfileConjunctionOperator\"\n }, {\n \"filter_name\" : \"ATTACK_TARGET\",\n \"filter_value\" : [ \"windows\" ],\n \"resource_type\" : \"IdsProfileFilterCriteria\"\n }, {\n \"operator\" : \"AND\",\n \"resource_type\" : \"IdsProfileConjunctionOperator\"\n }, {\n \"filter_name\" : \"ATTACK_TYPE\",\n \"filter_value\" : [ \"attempted-user\" ],\n \"resource_type\" : \"IdsProfileFilterCriteria\"\n }],\n \"overridden_signatures\": [\n {\n \"signature_id\": \"4102735\",\n \"enable\": false,\n \"_protection\": \"NOT_PROTECTED\"\n },{\n \"signature_id\": \"4102731\",\n \"enable\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n\n ],\n \"resource_type\" : \"IdsProfile\",\n \"marked_for_delete\" : false,\n \"overridden\" : false\n }\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-codegen-request-body-name": "IdsProfile"
}
},
"/infra/firewall-identity-stores/{firewall-identity-store-id}/groups": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Groups"
],
"summary": "Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)",
"description": "Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)",
"operationId": "SearchFirewallIdentityGroups",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "filter_value",
"in": "query",
"description": "Name search filter value",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryGroupListResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/123e4567-e89b-12d3-a456-42665544000/groups?filter_value=move\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"DirectoryGroup\",\n \"id\": \"a436e3ca-cf95-444e-bfa9-c36462063c02\",\n \"display_name\": \"movegrp1\",\n \"domain_id\": \"63329cea-99ae-4060-a5ae-f0da6ab67ef6\",\n \"distinguished_name\": \"CN=movegrp1,CN=Users,DC=nimbustest,DC=com\",\n \"_create_user\": \"system\",\n \"_create_time\": 1516656516152,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1516656517034,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"DirectoryGroup\",\n \"id\": \"ff56d298-8a9d-4da2-81ac-043f34fd2e15\",\n \"display_name\": \"movegrp2\",\n \"domain_id\": \"63329cea-99ae-4060-a5ae-f0da6ab67ef6\",\n \"distinguished_name\": \"CN=movegrp2,CN=Users,DC=nimbustest,DC=com\",\n \"_create_user\": \"system\",\n \"_create_time\": 1516656516151,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1516656517034,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/napp/common-agent/host-config": {
"get": {
"tags": [
"NSX Application Platform",
"Platform",
"Host Agent"
],
"summary": "Get NSX Application Platform Common Agent host configuration",
"description": "Get the current NSX Application Platform Common Agent host configuration.\nRecommend to keep the value same for flow_data_collection_interval\nand context_data_collection_interval.\n",
"operationId": "GetCommonAgentHostConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonAgentHostConfigurationInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgt>/api/v1/infra/napp/common-agent/host-config\n",
"x-vmw-nsx-module": "PolicyCloudNativeCommonAgent",
"x-vmw-nsx-example-response": "{\n \"kafka_endpoint\": [\n {\n \"address\": \"127.0.0.1\",\n \"port\": 9092\n }\n ],\n \"kafka_certificate\": \"pem-encoded-cert-value\",\n \"ingress_endpoint\": [\n {\n \"address\": \"127.0.0.1\",\n \"port\": 9092\n }\n ],\n \"ingress_certificate\": \"pem-encoded-cert-value\",\n \"truststore\": \"pem-encoded-cert-value\",\n \"nsx_cluster_id\": \"cluster-id-string\",\n \"private_ip_range\": [\n {\n \"address_type\": \"IPV4\",\n \"address\": \"10.0.0.0\",\n \"prefix_length\": 8\n },\n {\n \"address_type\": \"IPV4\",\n \"address\": \"172.16.0.0\",\n \"prefix_length\": 12\n },\n {\n \"address_type\": \"IPV4\",\n \"address\": \"192.168.0.0\",\n \"prefix_length\": 16\n }\n ],\n}\n"
},
"patch": {
"tags": [
"NSX Application Platform",
"Platform",
"Host Agent"
],
"summary": "Patch NSX Application Platform Common Agent host configuration",
"description": "Patch the current NSX Application Platform Common Agent host configuration.\nReturn error if NSX Application Platform Common Agent is not registered with NSX.\n\"private_ip_range\" is the only field allowed to patch.\n",
"operationId": "PatchCommonAgentHostConfiguration",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonAgentHostConfigurationInfo"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonAgentHostConfigurationInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgt>/api/v1/infra/napp/common-agent/host-config\n\n{\n \"private_ip_range\": [\n {\n \"address_type\": \"IPV4\",\n \"address\": \"10.10.0.0\",\n \"prefix_length\": 8\n },\n {\n \"address_type\": \"IPV4\",\n \"address\": \"172.18.0.0\",\n \"prefix_length\": 12\n },\n {\n \"address_type\": \"IPV4\",\n \"address\": \"192.169.0.0\",\n \"prefix_length\": 16\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyCloudNativeCommonAgent",
"x-vmw-nsx-example-response": "{\n \"kafka_endpoint\": [\n {\n \"address\": \"127.0.0.1\",\n \"port\": 9092\n }\n ],\n \"kafka_certificate\": \"pem-encoded-cert-value\",\n \"ingress_endpoint\": [\n {\n \"address\": \"127.0.0.1\",\n \"port\": 9092\n }\n ],\n \"ingress_certificate\": \"pem-encoded-cert-value\",\n \"truststore\": \"pem-encoded-cert-value\",\n \"nsx_cluster_id\": \"cluster-id-string\",\n \"private_ip_range\": [\n {\n \"address_type\": \"IPV4\",\n \"address\": \"10.10.0.0\",\n \"prefix_length\": 8\n },\n {\n \"address_type\": \"IPV4\",\n \"address\": \"172.18.0.0\",\n \"prefix_length\": 12\n },\n {\n \"address_type\": \"IPV4\",\n \"address\": \"192.169.0.0\",\n \"prefix_length\": 16\n }\n ]\n}\n",
"x-codegen-request-body-name": "CommonAgentHostConfigurationInfo"
}
},
"/tasks": {
"get": {
"tags": [
"System Administration",
"Configuration",
"NSX Managers",
"API Services",
"Task Management"
],
"summary": "Get information about all tasks",
"description": "Get information about all tasks",
"operationId": "ListTasks",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "request_uri",
"in": "query",
"description": "Request URI(s) to include in query result",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Status(es) to include in query result",
"schema": {
"type": "string"
}
},
{
"name": "user",
"in": "query",
"description": "Names of users to include in query result",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/tasks\n",
"x-vmw-nsx-module": "Tasks",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"start_time\" : 1478646470253,\n \"async_response_available\" : true,\n \"cancelable\" : false,\n \"end_time\" : 1478646470344,\n \"progress\" : 100,\n \"id\" : \"59c7d6c8-7d64-4f0e-8af5-0b5e92bc3330\",\n \"user\" : \"admin\",\n \"status\" : \"SUCCESS\"\n } ]\n}\n"
}
},
"/infra/certificates": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certificates"
],
"summary": "Return All the User-Facing Components' Certificates",
"description": "Returns all certificate information viewable by the user, including each\ncertificate's id; pem_encoded data; and history of the\ncertificate (who created or modified it and when). For additional\ninformation, include the ?details=true modifier at the end of the request\nURI.\n",
"operationId": "ListTlsCertificates",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "whether to expand the pem data and show all its details",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "node_id",
"in": "query",
"description": "Node ID of certificate to return",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type of certificate to return",
"schema": {
"type": "string",
"enum": [
"cluster_api_certificate",
"api_certificate"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCertificateList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/certificates\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"TlsCertificate\",\n \"id\": \"caCert\",\n \"display_name\": \"caCert\",\n \"path\": \"/infra/certificates/caCert\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"caCert\",\n \"details\": [ ... ],\n \"pem_encoded\": \"-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n\",\n \"has_private_key\": false,\n \"tls_certificate_type\": \"CERTIFICATE_CA\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516329725649,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516329725649,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"TlsCertificate\",\n \"id\": \"selfSignedCert\",\n \"display_name\": \"selfSignedCert\",\n \"path\": \"/infra/certificates/selfSignedCert\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"selfSignedCert\",\n \"details\": [\n {\n \"issuer_cn\": \"vSM Test Certificate\",\n \"public_key_length\": 1024,\n \"signature\": \"4e cf ff 36 ac a1\",\n \"not_before\": 1323772715000,\n \"subject\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"serial_number\": \"ca55f5e21a0b2dd2\",\n \"public_key_algo\": \"RSA\",\n \"version\": \"1\",\n \"issuer\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"is_ca\": false,\n \"subject_cn\": \"vSM Test Certificate\",\n \"not_after\": 1355308715000,\n \"is_valid\": false,\n \"rsa_public_key_exponent\": \"10001\",\n \"signature_algorithm\": \"SHA1WITHRSA\",\n \"rsa_public_key_modulus\": \"00 b7 8f 79 e4\"\n }\n ],\n \"pem_encoded\": \"-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n\",\n \"has_private_key\": true,\n \"tls_certificate_type\": \"CERTIFICATE_SELF_SIGNED\",\n \"unique_id\": \"e523b4c0-c3c5-4656-80a1-36dd0fab38cb\",\n \"realization_id\": \"e523b4c0-c3c5-4656-80a1-36dd0fab38cb\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516338671237,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516338671237,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Statistics"
],
"summary": "Get IDS gateway policy statistics",
"description": "Get statistics of a IDS gateway policy.\n- no enforcement point path specified: Stats will be evaluated on each enforcement.\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "GetIdsGatewayPolicyStatistics",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsSecurityPolicyStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/intrusion-service-gateway-policies/emergency/statistics?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyIDSStats",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n {\n \"rule\": \"ce-1\",\n \"internal_rule_id\": \"1001\",\n \"packet_count\": 3806,\n \"session_count\": 819,\n \"hit_count\": 45,\n \"byte_count\": 322989,\n \"popularity_index\": 85,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n },\n {\n \"rule\": \"ce-2\",\n \"internal_rule_id\": \"1002\",\n \"packet_count\": 8762,\n \"session_count\": 62,\n \"hit_count\": 45,\n \"byte_count\": 76201,\n \"popularity_index\": 13,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n }\n ],\n \"cursor\" : 1,\n \"result_count\" : 2\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/route-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Route Maps"
],
"summary": "List route maps",
"description": "Paginated list of all route maps under a tier-0\n",
"operationId": "ListAllRouteMaps",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0RouteMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/route-maps\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"RoueMap\",\n \"id\": \"rm1\",\n \"display_name\": \"rm1\",\n \"path\": \"/infra/tier-0s/vmc_prv/route-maps/rm1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"rm1\",\n \"entries\": [\n {\n \"community_list_matches\": [\n {\n \"criteria\": \"/infra/tier-0s/vmc/community-lists/cl1\",\n \"match_operator\": \"MATCH_ALL\"\n }],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n },\n {\n \"prefix_list_matches\": [ \"/infra/tier-0s/vmc/prefix-lists/pl1\" ],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/crls/{crl-id}?action=import": {
"post": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certification Revocation List"
],
"summary": "Create a new Certificate Revocation List",
"description": "Adds a new certificate revocation list (CRLs). The CRL is used to verify the client\ncertificate status against the revocation lists published by the CA. For this reason,\nthe administrator needs to add the CRL in certificate repository as well.\nA CRL can be in the PEM X.509 format (crl_type=X509) or JSON OneCRL\n(crl_type=OneCRL).\nIf crl_type is not specified, it is auto-detected based on the presence of\nfields pem_encoded or one_crl.\nAn X.509 CRL can contain a single CRL or multiple CRLs depending on the PEM data.\n- Single CRL: a single CRL is created with the given id.\n- Composite CRL: multiple CRLs are generated. Each of the CRL is created with an id\ngenerated based on the given id. First CRL is created with crl-id, second with crl-id-1,\nthird with crl-id-2, etc.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateTlsCrl",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "crl-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCrl"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCrlListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/crls/revokedCertsb\n{\n \"display_name\": \"Revoked Certificates\",\n \"pem_encoded\": \"-----BEGIN X509 CRL----------END X509 CRL-----\\n\"\n}\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"results\": [{\n \"resource_type\": \"TlsCrl\",\n \"display_name\": \"revoked certificates\",\n \"path\": \"/infra/crls/revokedCerts\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"revokedCerts\",\n \"pem_encoded\": \"-----BEGIN X509 CRL----------END X509 CRL-----\\n\",\n \"crl_type\": \"X509\",\n \"unique_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"realization_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1413387436438,\n \"_create_time\": 1413386249116,\n \"_create_user\": \"admin\"\n }]\n}\n",
"x-codegen-request-body-name": "TlsCrl"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-0 interface statistics information",
"description": "Get tier-0 interface statistics information.\n",
"operationId": "GlobalInfraGetTier0InterfaceStatistics",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-1409/interfaces/1-policyconnectivity-1005/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/2f82c631-edca-43a9-aa9f-b18f5be8dc02/edge-nodes/1\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_router_port_id\": \"/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-1409/interfaces/1-policyconnectivity-1005\",\n \"per_node_statistics\": [\n {\n \"last_update_timestamp\": 1627323668215,\n \"rx\": {\n \"total_bytes\": 0,\n \"total_packets\": 0,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"destination_unsupported_dropped_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"ipv6_dropped_packets\": 0,\n \"kni_dropped_packets\": 0,\n \"l4port_unsupported_dropped_packets\": 0,\n \"malformed_dropped_packets\": 0,\n \"no_receiver_dropped_packets\": 0,\n \"no_route_dropped_packets\": 0,\n \"proto_unsupported_dropped_packets\": 0,\n \"redirect_dropped_packets\": 0,\n \"rpf_check_dropped_packets\": 0,\n \"ttl_exceeded_dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 618,\n \"total_packets\": 12,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"dad_dropped_packets\": 0,\n \"frag_needed_dropped_packets\": 0,\n \"ipsec_pol_block_dropped_packets\": 0,\n \"ipsec_pol_err_dropped_packets\": 0,\n \"no_arp_dropped_packets\": 0,\n \"no_linked_dropped_packets\": 0,\n \"no_mem_dropped_packets\": 0,\n \"non_ip_dropped_packets\": 0,\n \"service_insert_dropped_packets\": 0\n }\n }\n ]\n}\n"
}
},
"/search/reconcile": {
"post": {
"tags": [
"Search",
"Search API"
],
"summary": "API to reconcile data in the search index",
"description": "This API will sync the data in search index based on the use case like upgrade, restore, etc.\n",
"operationId": "SearchReconcile",
"parameters": [
{
"name": "action",
"in": "query",
"description": "Reconciliation use case",
"required": true,
"schema": {
"type": "string",
"enum": [
"COMPLETE_REINDEXING",
"OPENSEARCH_RESTORE",
"PRODUCT_RESTORE",
"PRODUCT_UPGRADE",
"REBALANCE"
]
}
},
{
"name": "override",
"in": "query",
"description": "Override flag",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "scope",
"in": "query",
"description": "Re-indexing scope",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/search/reconcile?action=PRODUCT_RESTORE\n",
"x-vmw-nsx-module": "Search"
}
},
"/infra/lb-services/{lb-service-id}/lb-pools/{lb-pool-id}/detailed-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Usage",
"Status"
],
"summary": "Get LBPool status information",
"description": "Get LBPool detailed status information.\n- no enforcement point path specified: Information will be aggregated from\neach enforcement point.\n- {enforcement_point_path}: Information will be retrieved only from the\ngiven enforcement point.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "GetLBPoolStatus",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "lb-pool-id",
"in": "path",
"description": "LBPool id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateLBPoolStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyLBStatistics"
}
},
"/infra/settings/firewall/security/dependent-services": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings"
],
"summary": "Get the list of distributed firewall dependent services",
"description": "Get the list of distributed firewall dependent services\n",
"operationId": "GetDistributedFirewallDependentServices",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DependentServices"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/dependent-services\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"dependent_services\": [\n \"Distributed Firewall\",\n \"Identity Firewall\",\n \"Distributed Intrusion Detection and Prevention Service\",\n \"Distributed Load Balancer\"\n ]\n}\n"
}
},
"/global-infra/context-profiles/attributes": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "List Policy Context Profile supported attributes and sub-attributes",
"description": "Returns supported attribute and sub-attributes for specified\nattribute key with their supported values, if provided in query/request\nparameter, else will fetch all supported attributes and sub-attributes for\nall supported attribute keys.\nAlternatively, to get a list of supported attributes and sub-attributes fire the following REST API\nGET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes\n",
"operationId": "GlobalInfraListProfileSupportedAttributes",
"parameters": [
{
"name": "attribute_key",
"in": "query",
"description": "Fetch attributes and sub-attributes for the given attribute key",
"schema": {
"type": "string"
}
},
{
"name": "attribute_source",
"in": "query",
"description": "Source of the attribute, System Defined or custom",
"schema": {
"type": "string",
"default": "SYSTEM",
"enum": [
"ALL",
"CUSTOM",
"SYSTEM"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\": [\n \"SSL\"\n ],\n \"datatype\":\"STRING\",\n \"description\":\"SSL (Secure Sockets Layer) is a cryptographic protocol that provides security over the Internet.\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V10\",\n \"TLS_V11\",\n \"TLS_V12\",\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\",\n \"SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA\",\n ]\n \"datatype\":\"STRING\"\n }\n ],\n },\n {\n \"key\":\"DOMAIN_NAME\",\n \"value\": [\n \"*.office365.com\"\n ],\n \"datatype\":\"STRING\",\n \"description\":\"Office 365 url\"\n }\n ]\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster-ncpstatus": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Heatmap"
],
"summary": "Get all the container cluster status",
"description": "Get all the container cluster status",
"operationId": "GetContainerClusterStatusList",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Container status type",
"schema": {
"type": "string",
"enum": [
"UNKNOWN",
"HEALTHY",
"DOWN",
"DEGRADED"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContainerClusterStatusList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/container-cluster-ncpstatus\n",
"x-vmw-nsx-module": "PolicyHeatmap",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n \"cluster_id\": \"49bb701-4fe9-11e9-bdc7-000c29e49f11\",\n \"cluster_name\": \"PKS-Cluster-1\",\n \"type\": \"PKS\",\n \"status\": \"HEALTHY\",\n \"detail\":\"\"\n },\n {\n \"cluster_id\": \"b8b0889f-338c-5c65-98bd-a5642ae2aa00\",\n \"cluster_name\": \"PKS-Cluster-2\",\n \"type\": \"PKS\",\n \"status\": \"HEALTHY\",\n \"detail\":\"\",\n \"interval\": 180\n }\n ]\n}\n"
},
"post": {
"tags": [
"Policy",
"Monitoring",
"Heatmap"
],
"summary": "Create container cluster status",
"description": "Create container cluster status",
"operationId": "AddContainerClusterStatus",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContainerClusterStatus"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContainerClusterStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/container-cluster-ncpstatus\n\n{\n \"cluster_id\": \"b8b0889f-338c-5c65-98bd-a5642ae2aa00\",\n \"status\": \"HEALTHY\",\n \"detail\": \"\"\n}\n",
"x-vmw-nsx-module": "PolicyHeatmap",
"x-vmw-nsx-example-response": "{\n \"cluster_id\": \"b8b0889f-338c-5c65-98bd-a5642ae2aa00\",\n \"status\": \"HEALTHY\",\n \"detail\": \"\",\n \"interval\": 180\n}\n",
"x-codegen-request-body-name": "ContainerClusterStatus"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Get Segment QoS Profile Binding Map",
"description": "API will get Segment QoS Profile Binding Map.\n",
"operationId": "GetSegmentQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Update Segment QoS Profile Binding Map",
"description": "API will update Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "UpdateSegmentQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps/1\n{\n \"resource_type\":\" SegmentQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"description\":\"\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "SegmentQoSProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Delete Segment QoS Profile Binding Profile",
"description": "API will delete Segment QoS Profile Binding Profile.",
"operationId": "DeleteSegmentQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Create Segment QoS Profile Binding Map",
"description": "API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied.",
"operationId": "PatchSegmentQoSBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-qos-profile-binding-maps/1\n{\n \"resource_type\":\" SegmentQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-codegen-request-body-name": "SegmentQoSProfileBindingMap"
}
},
"/infra/sha/pre-defined-plugins": {
"get": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "API will provide list of Sha pre-defined list.",
"description": "API will provide list of Sha pre-defined plugins.\n",
"operationId": "ListShaPredefinedPlugins",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPreDefinedPluginListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sha/pre-defined-plugins\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n\"sort_ascending\": true,\n\"sort_by\": \"display_name\",\n\"result_count\": 1,\n\"results\": [\n {\n \"resource_type\": \"ShaPredefinedPlugin\",\n \"id\": \"6837ba7a-39cd-11eb-9f83-020068594730\",\n \"display_name\": \"System stats monitor plugin\",\n \"path\": /infra/sha/pre-defined-plugins/6837ba7a-39cd-11eb-9f83-020068594730\",\n \"parent_path\": \"/infra\",\n \"unique_id\" : \"88bf7bb8-02d6-4e93-8101-9f71841c5dfc\"\n \"relative_path\": \"88bf7bb8-02d6-4e93-8101-9f71841c5dfc\",\n \"enabled\": true,\n \"config\": {\n \"check_interval\": 20\n },\n \"node_type\":[\n \"NSX-EDGE\",\n \"NSX-MANAGER\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "List Service Interfaces",
"description": "Paginated list of all Service Interfaces\n",
"operationId": "ListServiceInterfaces",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInterfaceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/service-interfaces\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"ServiceInterface\",\n \"id\": \"to_internet\",\n \"display_name\": \"to_internet\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/default/service-interfaces/to_internet\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv/locale-services/default\",\n \"relative_path\": \"to_internet\",\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from segment interface (downlink)",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the\ninterface (downlink) attaching segment to tier-1 gateway, on a edge\nnode specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetSegmentInterfaceArpTable",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/segments/web-app-seg/arp-table?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"displayName\",\n \"result_count\": 3,\n \"interface_path\": \"/infra/realized-state/enforcement-points/default/logical-ports/t1-web-app-seg-dlrp\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\",\n example_response: |\n \"results\": [\n {\n \"mac_address\": \"00:50:56:8e:b4:21\",\n \"ip\": \"172.16.10.21\"\n },\n {\n \"mac_address\": \"02:50:56:56:44:52\",\n \"ip\": \"172.16.10.1\"\n },\n {\n \"mac_address\": \"00:50:56:8e:91:12\",\n \"ip\": \"172.16.10.11\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/realized-state/virtual-machines": {
"get": {
"tags": [
"Policy",
"Inventory",
"Virtual Machines"
],
"summary": "List all virtual machines",
"description": "This API filters objects of type virtual machine. This API also gives some VM\ndetails such as VM name, IDs and the current state of the VMs.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListAllVirtualMachines",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/realized-state/virtual-machines?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyRealizedState",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"compute_ids\": [\n \"moIdOnHost:1\",\n \"hostLocalId:1\",\n \"locationId:564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"instanceUuid:04fb2e78-e4bc-416f-b9dc-18b9f05e6227\",\n \"externalId:564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"biosUuid:564d75b2-7e28-7e78-dd77-64e5fd6128e1\"\n ],\n \"resource_type\": \"VirtualMachine\",\n \"external_id\": \"564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"source\": {\n \"target_display_name\": \"sc-rdops-vm09-dhcp-16-203.eng.vmware.com\",\n \"is_valid\": true,\n \"target_type\": \"HostNode\",\n \"target_id\": \"1afea8da-d4e2-11e7-93c3-c57b39f75a4f\"\n },\n \"_last_sync_time\": 1512031301409,\n \"display_name\": \"1-vm_ubuntu_1404_srv_64-local-586-04fb2e78-e4bc-416f-b9dc-18b9f05e6227\",\n \"type\": \"REGULAR\",\n \"power_state\": \"VM_RUNNING\",\n \"host_id\": \"1afea8da-d4e2-11e7-93c3-c57b39f75a4f\",\n \"local_id_on_host\": \"1\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Statistics"
],
"summary": "Get infra segments by configuration state",
"description": "Returns all infra segments with configuration state on the enforcement\npoint specified in the request\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentsByState",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "configuration_state",
"in": "query",
"description": "Configuration state of the segment on enforcement point",
"schema": {
"type": "string",
"enum": [
"pending",
"in_progress",
"success",
"failed",
"partial_success",
"orphaned",
"unknown"
]
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentConfigurationStateListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/state?configuration_state=success&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"segment_path\": \"/infra/segments/test-infra-seg\",\n \"state\": \"success\",\n \"details\": []\n },\n {\n \"segment_path\": \"/infra/segments/md-proxy-seg1\",\n \"state\": \"success\",\n \"details\": []\n },\n {\n \"segment_path\": \"/infra/segments/test-t0-dl\",\n \"state\": \"success\",\n \"details\": []\n },\n {\n \"segment_path\": \"/infra/segments/t0-ext-seg\",\n \"state\": \"success\",\n \"details\": []\n },\n {\n \"segment_path\": \"/infra/segments/TIER0_DOWN_LINK_SWITCH\",\n \"state\": \"success\",\n \"details\": []\n }\n ],\n \"result_count\": 5\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Inter-Vrf-Routing"
],
"summary": "Read inter-vrf routing config",
"description": "Read inter-vrf routing config.",
"operationId": "ReadPolicyInterVrfRoutingConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inter-vrf-routing-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterVrfRoutingConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Inter-Vrf-Routing"
],
"summary": "Create or update inter-vrf routing config",
"description": "Create or update inter-vrf routing config.",
"operationId": "UpdatePolicyInterVrfRoutingConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inter-vrf-routing-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterVrfRoutingConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterVrfRoutingConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/\n{\n\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n",
"x-codegen-request-body-name": "PolicyInterVrfRoutingConfig"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Inter-Vrf-Routing"
],
"summary": "Delete inter-vrf routing config",
"description": "Delete inter-vrf routing config.",
"operationId": "DeletePolicyInterVrfRoutingConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inter-vrf-routing-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Inter-Vrf-Routing"
],
"summary": "Create or update inter-vrf routing config",
"description": "Create or update inter-vrf routing config.",
"operationId": "PatchPolicyInterVrfRoutingConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inter-vrf-routing-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterVrfRoutingConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/\n{\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n",
"x-codegen-request-body-name": "PolicyInterVrfRoutingConfig"
}
},
"/infra/port-mirroring-profiles/{port-mirroring-profile-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Port Mirroring"
],
"summary": "Details of Port Mirroring Profile\n",
"description": "API will return details of port mirroring profile.\n",
"operationId": "ReadPortMirroringProfile",
"parameters": [
{
"name": "port-mirroring-profile-id",
"in": "path",
"description": "Port Mirroring Profile Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortMirroringProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles/session_2\n",
"x-vmw-nsx-module": "PolicyPortMirroring",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortMirroringProfile\",\n \"id\": \"session_2\",\n \"display_name\": \"/infra/infra/port-mirroring-profiles/session_2\",\n \"path\": \"/infra/infra/port-mirroring-profiles/session_2\",\n \"parent_path\": \"/infra/domains/d1/groups/group_vm\",\n \"relative_path\": \"session_2\",\n \"snap_length\": 744,\n \"destination_group\": \"/infra/domains/d1/groups/group_ip\",\n \"direction\": \"BIDIRECTIONAL\",\n \"encapsulation_type\":\"GRE\",\n \"gre_key\" : 5,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"Port Mirroring"
],
"summary": "Create or Replace Port Mirroring Profile.",
"description": "Create or Replace port mirroring profile. Packets will be mirrored from\nsource group, segment, port to destination group.\nRealized entities of this API can be found using the path of monitoring\nprofile binding map that is used to apply this profile.\n",
"operationId": "CreateOrReplacePortMirroringProfile",
"parameters": [
{
"name": "port-mirroring-profile-id",
"in": "path",
"description": "Port Mirroring Profiles Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortMirroringProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortMirroringProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles/session_2\n {\n \"snap_length\": 744,\n \"destination_group\": \"/infra/domains/d1/groups/group_ip\",\n \"direction\": \"BIDIRECTIONAL\",\n \"encapsulation_type\":\"GRE\",\n \"gre_key\" : 5\n }\n",
"x-vmw-nsx-module": "PolicyPortMirroring",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortMirroringProfile\",\n \"id\": \"session_2\",\n \"display_name\": \"session_2\",\n \"path\": \"/infra/port-mirroring-profiles/session_2\",\n \"parent_path\": \"/infra\",\n \"snap_length\": 744,\n \"destination_group\": \"/infra/domains/d1/groups/group_ip\",\n \"relative_path\": \"session_2\"\n \"direction\": \"BIDIRECTIONAL\",\n \"encapsulation_type\":\"GRE\",\n \"gre_key\" : 5\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "PortMirroringProfile"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"Port Mirroring"
],
"summary": "Delete Port Mirroring Profile",
"description": "API will delete port mirroring profile. Mirroring from source to destination\nports will be stopped.\n",
"operationId": "DeletePortMirroringProfile",
"parameters": [
{
"name": "port-mirroring-profile-id",
"in": "path",
"description": "Port Mirroring Profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles/session_1\n",
"x-vmw-nsx-module": "PolicyPortMirroring"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"Port Mirroring"
],
"summary": "Patch Port Mirroring Profile.",
"description": "Create a new Port Mirroring Profile if the Port Mirroring Profile with\ngiven id does not already exist. If the Port Mirroring Profile with the\ngiven id already exists, patch with the existing Port Mirroring Profile.\nRealized entities of this API can be found using the path of monitoring\nprofile binding map that is used to apply this profile.\n",
"operationId": "PatchPortMirroringProfile",
"parameters": [
{
"name": "port-mirroring-profile-id",
"in": "path",
"description": "Port Mirroring Profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortMirroringProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles/session_1\n {\n \"snap_length\": 744,\n \"destination_group\": \"/infra/domains/d1/groups/group_ip\",\n \"direction\": \"BIDIRECTIONAL\",\n \"encapsulation_type\":\"GRE\",\n \"gre_key\" : 5\n }\n",
"x-vmw-nsx-module": "PolicyPortMirroring",
"x-codegen-request-body-name": "PortMirroringProfile"
}
},
"/global-infra/flood-protection-profiles": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profiles"
],
"summary": "List Flood Protection Profiles",
"description": "API will list all Flood Protection Profiles",
"operationId": "GlobalInfraListFloodProtectionProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/flood-protection-profiles\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"FloodProtectionProfile\",\n \"description\": \"\",\n \"id\": \"profile-1\",\n \"display_name\": \"profile-1\",\n \"path\": \"/infra/flood-protection-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"udp_active_flow_limit\": 100,\n \"icmp_active_flow_limit\": 30,\n \"tcp_half_open_conn_limit\": 200,\n \"other_active_conn_limit\": 50,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/malware-prevention/transport-node/{transport-node-id}/status": {
"get": {
"tags": [
"Management Plane API",
"Security",
"Malware Prevention"
],
"summary": "Get status for MPS Transport Node.",
"description": "Returns current status of the deployment of MPS Service on a transport node.\n",
"operationId": "GetMpsTransportNodeStatus",
"parameters": [
{
"name": "transport-node-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MpsTransportNodeStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/malware-prevention/transport-node/832079fe-d8b8-4871-bd0a-d9f67a6d0ad4/status\n",
"x-vmw-nsx-module": "NsxMalwarePreventionDeployment",
"x-vmw-nsx-example-response": "{\n\"transport_node_id\": \"832079fe-d8b8-4871-bd0a-d9f67a6d0ad4\",\n\"deployment_status\": \"DEPLOYMENT_SUCCESSFUL\",\n\"deployment_issues\": [],\n\"service_health_status\": [\n {\n \"service_name\": \"HOST_COMPONENT\",\n \"service_status\": \"SERVICE_STATUS_UP\",\n \"last_update_time\": \"1694159733251\",\n \"is_stale\": false\n },\n {\n \"service_name\": \"SECURITY_HUB\",\n \"service_status\": \"SERVICE_STATUS_DOWN\",\n \"last_update_time\": \"1694159733251\",\n \"is_stale\": false\n }\n ],\n \"_protection\": \"NOT_PROTECTED\"\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/igmp-memberships": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Multicast"
],
"summary": "Get IGMP Memberships",
"description": "Get Igmp Memberships.\n",
"operationId": "GetPolicyIgmpMemberships",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IgmpMemberships"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-0s/tier0/locale-services/tier0localeservices/multicast/igmp-memberships\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"gateway_path\": \"/infra/tier-0s/tier0\",\n \"igmp_memberships_per_edge\": [\n {\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a9b95292-51f7-11ea-ae0d-005056a3c9f4\",\n \"igmp_memberships\": []\n },\n {\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a96e2790-51f7-11ea-aedf-005056a370d4\",\n \"igmp_memberships\": [\n {\n \"interface\": \"uplink-278\",\n \"source_address\": \"40.40.40.1\",\n \"group\": \"224.0.1.40\",\n \"no_of_sources\": \"1\",\n \"igmp_version\": 2,\n \"uptime\": \"11:53:34\"\n },\n {\n \"interface\": \"downlink-279\",\n \"source_address\": \"169.254.0.2\",\n \"group\": \"239.101.101.101\",\n \"no_of_sources\": \"1\",\n \"igmp_version\": 2,\n \"uptime\": \"11:53:34\"\n }\n ]\n }\n ]\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/ids-events": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Dashboard"
],
"summary": "Get the list of the IDS events that are detected, grouped by signature id.",
"description": "Get the list of the IDS events that are detected with the total number of\nintrusions detected, their severity and the time they occurred,\ngrouped by signature id.\n",
"operationId": "GetPolicyAllIdsEvents",
"parameters": [
{
"name": "context",
"in": "query",
"description": "Tenancy Context of the API request",
"schema": {
"type": "string",
"enum": [
"ALL_PROJECTS"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsEventDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsEventsBySignatureResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-events\n {\n \"filters\": [\n {\n \"field_names\": \"signature_detail.severity\",\n \"value\": \"HIGH OR CRITICAL\"\n }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyIDSMetrics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"signature_id\": 4010643,\n \"signature_name\": \"ET TROJAN [eSentire] Win32/GandCrab v4/5 Ransomware CnC Activity\",\n \"severity\": \"HIGH\",\n \"count\": 87,\n \"first_occurence\": 1590516802000,\n \"resource_type\": \"IDSEvent\"\n },\n {\n \"signature_id\": 4101968,\n \"signature_name\": \"SLR Alert - GrandCrabv5 Ransomware Infection - POST to CnC\",\n \"severity\": \"CRITICAL\",\n \"count\": 1002,\n \"first_occurence\": 1590516798000,\n \"resource_type\": \"IDSEvent\"\n }\n ]\n}\n",
"x-codegen-request-body-name": "PolicyIdsEventDataRequest"
}
},
"/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Get infra segment port security profile binding map",
"description": "API will return details of the port security profile binding map. If the\nsecurity profile binding map does not exist, it will return 404.\n",
"operationId": "GlobalInfraGetInfraSegmentPortSecurityProfileBinding",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130261922,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130261922,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Create or replace the infra segment port security profile binding map",
"description": "API will create or replace the port security profile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "GlobalInfraCreateOrUpdateInfraSegmentPortSecurityProfileBinding",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n {\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130261922,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130261922,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130261922,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130308980,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortSecurityProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Delete the infra segment port security profile binding map",
"description": "API will delete the port security profile binding map.\n",
"operationId": "GlobalInfraDeleteInfraSegmentPortSecurityProfileBinding",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Patch infra segment port security profile binding map",
"description": "Create a new port security profile binding map if the given security profile\nbinding map does not exist. Otherwise, patch the existing port security\nprofile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "GlobalInfraPatchInfraSegmentPortSecurityProfileBinding",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n {\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguard_1\",\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segment_security_1\"\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-codegen-request-body-name": "PortSecurityProfileBindingMap"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-context/l2vpns/{l2vpn-id}/peer-config": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Get Peer Config for L2Vpn",
"description": "Get peer config for the L2Vpn to configure the remote side of the tunnel.\n- no enforcement point path specified: L2Vpn Peer Codes will be evaluated on\neach enforcement point.\n- {enforcement_point_path}: L2Vpn Peer Codes are evaluated only on the given\nenforcement point.\nThis API is deprecated. Please use GET /infra/tier-0s//locale-services/\n/l2vpn-services/default/sessions/L2VPN_/peer-config\n instead.\n",
"operationId": "ReadL2VpnPeerConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "l2vpn-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VpnPeerConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/l2vpn-context/l2vpns/pa-pune-l2vpn/peer-codes\n",
"x-vmw-nsx-module": "PolicyL2Vpn",
"x-vmw-nsx-example-response": "{\n \"l2vpn_path\": \"/infra/tier-0s/vmc/locale-services/default/l2vpn-services/default/sessions/L2VPN_pa-pune-l2vpn\",\n \"l2vpn_peer_config_per_enforcement_point\": [\n {\n \"resource_type\": \"L2VpnPeerCodes\",\n \"enforcement_point_path\": \"/infra/deployment-zones/default/enforcement-points/nsxt\",\n \"peer_codes\": [\n {\n \"peer_code\": \"MCw0YTc2YTNlLHsic2l0ZU5hbWUiOiJwb2xpY3ktc2Vzc2lvbi1QUk9WSUuMTEuMTEifV19\",\n \"transport_tunnel_path\": \"/infra/tier-0s/vmc/locale-services/default/ipsec-vpn-services/default/sessions/L3VPN_pa-pune-rb-vpn\"\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machines/{virtual-machine-id}/tags": {
"post": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Virtual Machines"
],
"summary": "Apply tags on virtual machine under VPC",
"description": "Allows an admin to apply multiple tags to a virtual machine under VPC. This operation\ndoes not store the intent on the policy side. It applies the tag directly\non the specified enforcement point. This operation will replace the existing\ntags on the virtual machine with the ones that have been passed. If the\napplication of tag fails on the enforcement point, then an error is\nreported. The admin will have to retry the operation again. Policy\nframework does not perform a retry. Failure could occur due to multiple\nreasons. For e.g enforcement point is down, Enforcement point could not\napply the tag due to constraints like max tags limit exceeded, etc.\nNOTE: The \"virtual_machine_id\" field in the payload will be ignored and the\nvirtual machine ID provided in the URL will be honored.\n",
"operationId": "ApplyTagOnVirtualMachineVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "virtual-machine-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineTagsUpdate"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/orgs/default/projects/p-1/vpcs/vpc-1/virtual-machines/502e2a4e-cb8a-2385-861b-d3cca41848c0/tags\n{\n \"tags\": [\n {\"tag\": \"web-vm\", \"scope\": \"web\"},\n {\"tag\": \"WINDOWS\", \"scope\": \"ostype\"}\n ]\n}\n",
"x-vmw-nsx-module": "PolicyVpcTag",
"x-codegen-request-body-name": "VirtualMachineTagsUpdate"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-0 interface group statistics information",
"description": "Get tier-0 interface group statistics information.\n",
"operationId": "GetTier0InterfaceGroupStatistics",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceGroupStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-1409/interface-groups/1-policyconnectivity-1005/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/2f82c631-edca-43a9-aa9f-b18f5be8dc02/edge-nodes/1\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"members\": [\n {\n \"logical_router_port_id\": \"/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-1409/interface-groups/1-policyconnectivity-1005\",\n \"per_node_statistics\": [\n {\n \"last_update_timestamp\": 1627323668215,\n \"rx\": {\n \"total_bytes\": 0,\n \"total_packets\": 0,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"destination_unsupported_dropped_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"ipv6_dropped_packets\": 0,\n \"kni_dropped_packets\": 0,\n \"l4port_unsupported_dropped_packets\": 0,\n \"malformed_dropped_packets\": 0,\n \"no_receiver_dropped_packets\": 0,\n \"no_route_dropped_packets\": 0,\n \"proto_unsupported_dropped_packets\": 0,\n \"redirect_dropped_packets\": 0,\n \"rpf_check_dropped_packets\": 0,\n \"ttl_exceeded_dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 618,\n \"total_packets\": 12,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"dad_dropped_packets\": 0,\n \"frag_needed_dropped_packets\": 0,\n \"ipsec_pol_block_dropped_packets\": 0,\n \"ipsec_pol_err_dropped_packets\": 0,\n \"no_arp_dropped_packets\": 0,\n \"no_linked_dropped_packets\": 0,\n \"no_mem_dropped_packets\": 0,\n \"non_ip_dropped_packets\": 0,\n \"service_insert_dropped_packets\": 0\n }\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-subnets": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "List IpAddressPoolSubnets",
"description": "Paginated list of IpAddressPoolSubnets.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIpAddressPoolSubnets",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPoolSubnetListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1/ip-subnets\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"IpAddressPoolBlockSubnet\",\n \"id\": \"Subnet-1\",\n \"display_name\": \"Subnet-1\",\n \"path\": \"/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\",\n \"parent_path\": \"/infra/ip-pools/IpPool-Tenant-1/ip-subnets\",\n \"relative_path\": \"Subnet-1\",\n \"size\": \"16\",\n \"ip_block_path\":\"/infra/ip-blocks/Finance-block\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-0 interface statistics summary information",
"description": "Get tier-0 interface statistics summary information.\n",
"operationId": "GlobalInfraGetTier0InterfaceStatisticsSummary",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatisticsSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-63/interfaces/1-policyconnectivity-450/statistics/summmary?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"tx\": {\n \"dropped_packets\": 10,\n \"total_bytes\": 12172280,\n \"total_packets\": 60789\n },\n \"last_update_timestamp\": 1457125987869,\n \"rx\": {\n \"dropped_packets\": 8535,\n \"total_bytes\": 2085660,\n \"total_packets\": 33952\n },\n \"logical_router_port_id\": \"9b2ec1c5-cb54-4d69-8d64-14ccad6ae3cf\",\n \"interface_policy_path\": \"/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-63/interfaces/1-policyconnectivity-450\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"ARP Proxies"
],
"summary": "Get Tier-1 Address Resolution Protocol Proxies",
"description": "Get Tier-1 Address Resolution Protocol Proxies.\n
\nThis API is deprecated. Please use /infra/tier-1s/<tier-1-id>/arp-proxies\nReturns ARP proxy table for a tier-1\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1ArpProxies",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s/pepsi/locale-services/1-policyconnectivity-1340/arp-proxies\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"22\",\n \"arp_proxy_ip\" : \"10.22.2.42\"\n },\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/gateway-qos-profiles/{qos-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Read gateway QoS profile",
"description": "Read gateway QoS profile",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadGatewayQosProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"committed_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\",\n \"resource_type\": \"GatewayQosProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"profile1\",\n \"path\": \"/infra/gateway-qos-profiles/profile1\",\n \"relative_path\": \"profile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"bafc4055-e594-43c8-8b11-6a9fba9a75f7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594593920917,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594593920921,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Create or update Gateway QoS profile",
"description": "If profile with the qos-profile-id is not already present,\ncreate a new gateway QoS profile instance. If it already exists, replace\nthe gateway QoS profile instance with this object.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrReplaceGatewayQosProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n{\n \"committed_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"committed_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\",\n \"resource_type\": \"GatewayQosProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"profile1\",\n \"path\": \"/infra/gateway-qos-profiles/profile1\",\n \"relative_path\": \"profile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"bafc4055-e594-43c8-8b11-6a9fba9a75f7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594593920917,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594593920921,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "GatewayQosProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Delete gateway QoS profile",
"description": "Delete QoS profile",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteGatewayQosProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Gateway QOS Profiles"
],
"summary": "Create or update Gateway QoS profile",
"description": "If profile with the qos-profile-id is not already present,\ncreate a new gateway QoS profile instance. If it already exists, update\nthe gateway QoS profile instance with specified attributes.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchGatewayQosProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "qos-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayQosProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/gateway-qos-profiles/profile1\n{\n \"commited_bandwidth\": 1000,\n \"burst_size\": 1000000,\n \"excess_action\": \"DROP\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "GatewayQosProfile"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/stats?action=reset": {
"post": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Reset DHCP server statistics counters",
"description": "Reset DHCP statistics counters of a DHCP server represented by the\nconnectivity_path and the enforecement_point_path where the\ndhcp-server-config was applied to. The connectivity_path can be the Tier0\npath, Tier1 path or a segment path. If the given Tier0/1 or Segment has\nDHCP server applied, the resetting will succeed and the DHCP statistics\ncounters will be reset to 0. But if it has no DHCP server applied, the\nreseting will fail with proper error message.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraResetDhcpServerStats",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/stats?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{}\n"
}
},
"/infra/sites/{site-id}/napp/deployment/platform/form-factors": {
"get": {
"tags": [
"NSX Application Platform",
"Deployment",
"Platform",
"Form Factors"
],
"summary": "Get available deployment form factors for NSX Application Platform",
"description": "Get available deployment form factors for NSX Application Platform.",
"operationId": "GetAvailableFormFactors",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlatformFormFactors"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/napp/deployment/platform/form-factors\n",
"x-vmw-nsx-module": "PolicyCloudNativePlatform",
"x-vmw-nsx-example-response": "{\n \"available_form_factors\":{\n \"standard\": {\n \"node\": {\n \"cpu\": 4,\n \"ram\": 16\n \"disk\": \"200\"\n },\n \"supported_features\": [\"NDR\", \"Antimalware\", \"Rule Analysis\", \"Metrics\"]\n },\n \"advanced\": {\n \"node\": {\n \"cpu\": 32,\n \"ram\": 64\n \"disk\": \"1000\"\n },\n \"supported_features\": [\"NDR\", \"Antimalware\", \"Rule Analysis\", \"Metrics\", \"NSX Intelligence\"]\n },\n \"evaluation\": {\n \"node\": {\n \"cpu\": 32,\n \"ram\": 64\n \"disk\": \"1000\"\n },\n \"supported_features\": [\"NDR\", \"Antimalware\", \"Rule Analysis\", \"Metrics\", \"NSX-Intelligence\"]\n }\n }\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vc-folder-status": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"VPC"
],
"summary": "VC Folder Status for Vpc",
"description": "Returns the VC Folder Status on vCenter for the Vpc.\n",
"operationId": "GetVpcVCFolderStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VCFolderStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/vc-folder-status\n",
"x-vmw-nsx-module": "PolicyVpc",
"x-vmw-nsx-example-response": "{\n \"vds_folder_display_name\": \"vpc-1\",\n \"overall_status\": \"success\",\n \"vds_folders_state\": [\n {\n \"vds_uuid\": \"50 04 09 e8 84 78 77 1a-d8 41 68 c0 78 09 49 4c\",\n \"vds_display_name\": \"TestDSwitch\",\n \"folder_moid\": \"group-n62\",\n \"state\": \"Success\"\n }\n ]\n}\n"
}
},
"/global-infra/domains/{domain-id}/domain-deployment-maps/{domain-deployment-map-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Domains",
"Domain Deployment Maps"
],
"summary": "Read a DomainDeploymentMap",
"description": "Read a Domain Deployment Map\n",
"operationId": "GlobalInfraReadDomainDeploymentMapForInfra",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-deployment-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainDeploymentMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains//domain-deployment-maps/\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"resource_type\": \"DomainDeploymentMap\",\n \"id\": \"ddm5\",\n \"display_name\": \"ddm5\",\n \"path\": \"/infra/domains/SecureWorkload/domain-deployment-maps/ddm5\",\n \"relative_path\": \"ddm5\",\n \"parent_path\": \"/infra/domains/SecureWorkload\",\n \"unique_id\": \"f7aef601-4e4b-420f-8fe2-a3d1ab709ae7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1604097081666,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1604097081669,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Network Services",
"NAT"
],
"summary": "Get NAT Rule Statistics",
"description": "Get NAT Rule Statistics from VPC denoted by VPC ID, under NAT section\ndenoted by <nat-id>.\nUnder VPC there will be 2 different NATs(sections).\n(USER and NAT64)\nFor more details related to NAT section please refer to PolicyNAT schema.\n",
"operationId": "GetPolicyVpcNatRuleStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"description": "NAT id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action on statistics",
"schema": {
"type": "string",
"enum": [
"aggregate"
]
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyNatRuleStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyVpcNat",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"rule_path\": \"/orgs/org1/projects/project1/vpcs/vpc1/nat/USER/nat-rules/1\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"rule_statistics\": [\n {\n \"total_bytes\": 0,\n \"active_sessions\": 0,\n \"total_packets\": 0,\n \"last_update_timestamp\": 1537502752201\n },\n {\n \"total_bytes\": 0,\n \"active_sessions\": 0,\n \"total_packets\": 0,\n \"last_update_timestamp\": 1537502753915\n }\n ]\n }\n ]\n }\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Get port security profile binding map",
"description": "API will return details of the port security profile binding map. If the\nsecurity profile binding map does not exist, it will return 404.\n",
"operationId": "GetPortSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130135604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130135604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Create or replace the port security profile binding map",
"description": "API will create or replace the port security profile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "CreateOrUpdatePortSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n {\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130135604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130135604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130135604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130486350,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortSecurityProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Delete the port security profile binding map",
"description": "API will delete the port security profile binding map.\n",
"operationId": "DeletePortSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Patch port security profile binding map",
"description": "Create a new port security profile binding map if the given security profile\nbinding map does not exist. Otherwise, patch the existing port security\nprofile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "PatchPortSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n {\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguard_1\",\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segment_security_1\"\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-codegen-request-body-name": "PortSecurityProfileBindingMap"
}
},
"/infra/tier-0s/{tier-0-id}/arp-proxies?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"ARP Proxies"
],
"summary": "Get Tier-0 Address Resolution Protocol Proxies in CSV format",
"description": "Returns ARP proxy table for a tier-0 in CSV format\n",
"operationId": "GetTier0GatewayArpProxiesInCsv",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-0s/pepsi/arp-proxies?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "TODO : smanikarnike\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/forwarding?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Multicast"
],
"summary": "Get Multicast Forwarding In Csv Format",
"description": "Get Multicast Forwarding In CSV Format.\n",
"operationId": "GetTier1PolicyMulticastForwardingInCsvFormat",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyMulticastForwardingInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s/tier1/locale-services/tier1localeservices/multicast/forwarding?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "transport_node,source,multicast_group,incoming_interface,outgoing_interfaces\n\"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a96e2790-51f7-11ea-aedf-005056a370d4\",1.1.5.10,239.102.102.102,\"e60c61b4-acf9-4db6-91b8-1ed1bb8732bd\",\"/infra/tier-1s/tier1/locale-services/tier1localeservices/interfaces/tier1-interface-40-40-40-1\"\n"
}
},
"/infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from tier-0 router link interface in CSV format",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format\nfor the tier-0 router link interface, on a edge node. The edge_path\nparameter is mandatory if the interface type is not EXTERNAL.\n",
"operationId": "GetTier0RouterLinkArpTableCsv",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "tier1_path",
"in": "query",
"description": "Policy path of tier1",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments (Fixed)"
],
"summary": "Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.",
"description": "Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.\nThis API call does not return flexible segments (identified as /policy/api/v1/infra/segments/) connected to the Tier-1.\nTo return all segments connected as a downlink to a Tier-1 one possibility is to use the search API with: https://{{nsx-mgr}}/policy/api/v1/search?query=resource_type:Segment%20AND%20connectivity_path:“/infra/tier-1s/\nExtended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the\n\"l2_extension\" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path\ninstead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.\nAlso note that l2vpn path included in the error messages returned from validation may include the new VPN path\ninstead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListSegments",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "segment_type",
"in": "query",
"description": "Segment type",
"schema": {
"type": "string",
"enum": [
"DVPortgroup",
"ALL"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/segments\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Segment\",\n \"id\": \"web-tier\",\n \"display_name\": \"web-tier\",\n \"path\": \"/infra/tier-1s/cgw/segments/web-tier\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [\n \"40.1.2.0/24\"\n ]\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668961954,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668961954,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Revise the positioning of IDS gateway policy",
"description": "This is used to set a precedence of a IDS gateway policy w.r.t others.\n",
"operationId": "ReviseIdsGatewayPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsGatewayPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsGatewayPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/vmc/intrusion-service-gateway-policies/cgw-1?action=revise&anchor_path=/infra/domains/vmc/intrusion-service-gateway-policies/cgw-2&operation=insert_before\n{\n \"description\": \"policy revised\",\n \"display_name\": \"cgw-1\",\n \"category\": \"SharedPreRules\",\n \"rules\": [\n {\n \"description\": \" rule\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"scope\": [\n \"/infra/tier-1s/cgw\"\n ],\n \"action\": \"ALLOW\"\n }\n\n ]\n}\n",
"x-vmw-nsx-module": "PolicyIDSGateway",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IdsGatewayPolicy\",\n \"description\": \"comm map revised\",\n \"id\": \"cgw-1\",\n \"display_name\": \"cgw-1\",\n \"path\": \"/infra/domains/vmc/intrusion-service-gateway-policies/cgw-1\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"cgw-1\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/intrusion-service-gateway-policies/cgw1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/intrusion-service-gateway-policies/cgw1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"/infra/tier-1s/cgw\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ],\n \"category\": \"SharedPreRules\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 20000,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317362027,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "IdsGatewayPolicy"
}
},
"/infra/segments/{segment-id}/bep-statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Bridge Endpoints",
"Statistics"
],
"summary": "Get infra segment bridge end point statistics using segment ID and profile path.",
"description": "Get detailed information on infra segment bridge end point statistics using segment ID and profile path.\n",
"operationId": "InfraSegmentBridgeEndpointStatistics",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bridge_profile_path",
"in": "query",
"description": "Bridge profile path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BridgeEndpointStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "# TODO: change this sample request after api is tested\nGET https://<policy-mgr>/policy/api/v1/infra/segments/segment-1/bep-statistics?bridge_profile_path=/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{ # TODO: change this sample response after api is tested\n \"tx_packets\": {\n \"total\": 159,\n \"dropped\": 0,\n \"multicast_broadcast\": 0\n },\n \"rx_bytes\": {\n \"total\": 1028,\n \"multicast_broadcast\": 0\n },\n \"tx_bytes\": {\n \"total\": 10438,\n \"multicast_broadcast\": 0\n },\n \"rx_packets\": {\n \"total\": 11,\n \"dropped\": 0,\n \"multicast_broadcast\": 0\n },\n \"last_update_timestamp\": 1457518122686,\n \"endpoint_id\": \"15269939-779a-4fa4-9a0a-792dbf9fac12\"\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/advertised-networks/csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Routing"
],
"summary": "List advertised networks in CSV format",
"description": "Return networks which are advertised to connected TIER0 gateway in CSV format.\n",
"operationId": "GetTier1AdvertisedNetworksInCsvFormat",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyAdvertisedNetworkInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s//advertised-networks/csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n}\n"
}
},
"/infra/lb-services/{lb-service-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Usage",
"Statistics"
],
"summary": "Get LBService statistics information",
"description": "Get LBServiceStatistics information.\n- no enforcement point path specified: Information will be aggregated from\neach enforcement point.\n- {enforcement_point_path}: Information will be retrieved only from the\ngiven enforcement point.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "GetLBServiceStatistics",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateLBServiceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyLBStatistics"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/dns-forwarder-zones": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"DNS Zones"
],
"summary": "List Dns Forwarder Zones",
"description": "Paginated list of all Dns Forwarder Zones\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListPolicyDnsForwarderZone",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDnsForwarderZoneListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dns-forwarder-zones\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\" : true,\n \"sort_by\" : \"display_name\",\n \"result_count\" : 2,\n \"results\" : [ {\n \"resource_type\" : \"PolicyDnsForwarderZone\",\n \"id\" : \"default-1\",\n \"display_name\" : \"$1\",\n \"path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"parent_path\" : \"/infra/dns-forwarder-zones/default-1\",\n \"relative_path\" : \"default-1\",\n \"dns_domain_names\" : [ ],\n \"upstream_servers\" : [ \"3.3.3.3\", \"4.4.4.4\" ],\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517400275031,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517400275031,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 0\n }, {\n \"resource_type\" : \"PolicyDnsForwarderZone\",\n \"id\" : \"conditional-1\",\n \"display_name\" : \"$1\",\n \"path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"parent_path\" : \"/infra/dns-forwarder-zones/conditional-1\",\n \"relative_path\" : \"conditional-1\",\n \"dns_domain_names\" : [ \"foo.com\" ],\n \"upstream_servers\" : [ \"1.1.1.1\", \"2.2.2.2\" ],\n \"_create_user\" : \"a;a\",\n \"_create_time\" : 1517400132921,\n \"_last_modified_user\" : \"a;a\",\n \"_last_modified_time\" : 1517400132921,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 0\n } ]\n}\n"
}
},
"/cluster/backups/config": {
"get": {
"tags": [
"System Administration",
"Lifecycle Management",
"Backup Restore Management",
"Backup"
],
"summary": "Get backup configuration",
"description": "Get a configuration of a file server and timers for automated backup.\nFields that contain secrets (password, passphrase) are not returned.\n",
"operationId": "GetBackupConfig",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "BackupConfiguration",
"x-vmw-nsx-example-response": "{\n \"backup_enabled\" : true;\n \"backup_schedule\":{\n \"resource_type\": \"WeeklyBackupSchedule\",\n \"days_of_week\":[\n 1,\n 3,\n 5\n ],\n \"hour_of_day\":0,\n \"minute_of_day\":0\n },\n \"remote_file_server\":{\n \"server\":\"10.1.2.3\",\n \"port\":22,\n \"protocol\":{\n \"protocol_name\":\"sftp\",\n \"ssh_fingerprint\":\"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA\",\n \"authentication_scheme\":{\n \"scheme_name\":\"PASSWORD\",\n \"username\":\"admin\"\n }\n },\n \"directory_path\":\"/nsx-backups\"\n },\n \"inventory_summary_interval\":300\n}\n"
},
"put": {
"tags": [
"System Administration",
"Lifecycle Management",
"Backup Restore Management",
"Backup"
],
"summary": "Configure backup",
"description": "Configure file server and timers for automated backup.\nIf secret fields are omitted (password, passphrase)\nthen use the previously set value.\n",
"operationId": "ConfigureBackupConfig",
"parameters": [
{
"name": "frame_type",
"in": "query",
"description": "Frame type",
"schema": {
"type": "string",
"default": "LOCAL_LOCAL_MANAGER",
"enum": [
"GLOBAL_MANAGER",
"LOCAL_MANAGER",
"LOCAL_LOCAL_MANAGER",
"NSX_INTELLIGENCE"
]
}
},
{
"name": "site_id",
"in": "query",
"description": "Site ID",
"schema": {
"type": "string",
"default": "localhost"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupConfiguration"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/api/v1/cluster/backups/config?site_id=fec18cee-ccf7-4d7c-bcc2-8634b08195cd&frame_type=LOCAL_MANAGER\n{\n \"backup_enabled\" : true,\n \"backup_schedule\":{\n \"resource_type\": \"WeeklyBackupSchedule\",\n \"days_of_week\":[\n 1,\n 3,\n 5\n ],\n \"hour_of_day\":0,\n \"minute_of_day\":0\n },\n \"remote_file_server\":{\n \"server\":\"10.1.2.3\",\n \"port\":22,\n \"protocol\":{\n \"protocol_name\":\"sftp\",\n \"ssh_fingerprint\":\"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA\",\n \"authentication_scheme\":{\n \"scheme_name\":\"PASSWORD\",\n \"username\":\"admin\",\n \"password\":\"default\"\n }\n },\n \"directory_path\":\"/nsx-backups\"\n },\n \"passphrase\":\"swordfish\",\n \"inventory_summary_interval\":300\n}|\n\nPUT https://<nsx-mgr>/api/v1/cluster/backups/config\n{\n \"backup_enabled\" : true,\n \"backup_schedule\":{\n \"resource_type\": \"IntervalBackupSchedule\",\n \"seconds_between_backups\":3600\n },\n \"remote_file_server\":{\n \"server\":\"10.1.2.3\",\n \"port\":22,\n \"protocol\":{\n \"protocol_name\":\"sftp\",\n \"ssh_fingerprint\":\"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA\",\n \"authentication_scheme\":{\n \"scheme_name\":\"KEY\",\n \"username\":\"admin\",\n \"identity_file\":\"-----BEGIN PRIVATE KEY-----\\nMIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAQCfJGCSdJx+qKxt\\nE4vmwdLYbFjeuYMNqC3YfB+6sWcqkkZc708zlIyl7Z3F4PE3THDWBo6gCCa3vi6E\\nL8HRHUcl8HM4iZxUt352MEJkUuUtkn5tMI5phm9r6bZS736w+AsyYawcOpI24253\\nuqPWRXv1VzFJBwk+lgBlzEuarcH7krimBfC1pJdyG7KsfPhTiwtgXA7b2Hz6p9Ub\\nuozZ9A1OigyR6QbFKJ/Fl0EsmUinRsPFkeiijF3uQuTUPl0lhty+UY99GmmRQ0+v\\nH2wKUbyh6+T4vmhBhVrBTqhCfIJrD6ZJin20AYJUxiu9SSdLq7HzMR4LnEe78/0T \\nlGG7yP0jAgMBAAECggEAG94+bRcvmnyGKVm9a4zwk8axb1tUKE2Vra3azpIna0yP\\nNtIPcAxo7tuj/9Vq2FCyB8DBNCQJR67trWdBjRGP9oRbYQC0GB/D7QV5cuETUf4v\\n1oYkwjTxCRg1veNDr9DYARwajBzzotoD68KK00h6sxVwQ4YQZ93Ttv/mE3GvIRMj\\nQN1s6VbFe7jUpEzfJO6/Mg4aRKrFEIp/5q7NRT4jwY4UBJlEC0I9zhrs4rnyIjWR\\nLpazAmugcMQ4Uj8xaIDg4rb/KfjdiitivW+6AhXd49RLm6GXncXv1hwN6wZ1Punb\\nxV8+xwt9BS5gwBuNASokjwOTswj+bxYXTsaxHPfjvQKBgQDMhsssUOhLJrohcGdR\\n3dF/jeJZ6a+GMydBhiVdWHAhx1prEcjH65o0jpWefpk3XiJVcTtdhHtU8Qamm0xV\\nVxaVd8W9LJZBRmjJ0VAzghBWzq4je3pw6JAIhVYL3bWzR74xVa9NiFXu8ZqLsJjw\\nNlEPQ9vZQZwIDUOs1p9as7PUFQKBgQDHMY+8x/YyyYRhLCsqgdynV3Lc2J5Hk9bN \\nqo604uhEAJTbHTZ7WwRAT9QNbIBJwx7j5z1m4MEUq0RFe+MDyW+ACxz+oIGrgmMe\\nVcNdvlzQHGywo3BC5CvygU1RrSnu1pqeLk9Vo5KXTz3rAr59Icw54rw7BC7b2RqY\\nSnmQUCTCVwKBgBjJ0YAagjzxgaeh3vPeJZEHGkL5fquOMZjQcGDi4hxF9CB79FC+ \\nrl7mVR3zjBBY2WJvqdlIwEXoPH0e316MgpE1BgNKjx90MCkdtFG51s8el553Tby3\\ngxV1S5t+kJIdBOEn2GpWNswR/kAl9DNQ8fweplurhwS2ztf43zF4DDiNAoGARpo1\\nhUcm53dv2XVrU2S2DgY76zVIXLx07W7fqBOpGblPCZ8AGZb4GcdxtNRZYEutnj/v \\nDpDpPuc5iptPqp7yS2MlAsdnTqAne7AQUCDSCt2YVL+JYdw4C3tzKVkEPOiJ4zks\\n24Dfy4vFuY++buHU3kuURiLEbR41g/cZwWH2tX8CgYAaXJvi9UkNlYfcIzsTqnkC\\nmEJt1keFgoD6U0VK2SWL65EL24s5bC81cVtQo6cuVRiAbKKyvcI0/qwnDqIRa9/J\\nuakA4piJcmbae9qSNRdloIYdYKT4k7DRHoh45eB7ZKdCu76gUUllOAdr8DGF6xBr\\nzHPHeBNiX4ORwTewAEf+VA==\\n-----END PRIVATE KEY-----\"\n }\n },\n \"directory_path\":\"/nsx-backups\"\n },\n \"passphrase\":\"swordfish\",\n \"inventory_summary_interval\":300\n}|\nPUT https://<nsx-mgr>/api/v1/cluster/backups/config\n {\n \"backup_enabled\" : true,\n \"backup_schedule\":{\n \"resource_type\": \"IntervalBackupSchedule\",\n \"seconds_between_backups\":3600\n },\n \"remote_file_server\":{\n \"server\":\"10.1.2.3\",\n \"port\":22,\n \"protocol\":{\n \"protocol_name\":\"sftp\",\n \"ssh_fingerprint\":\"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA\",\n \"authentication_scheme\":{\n \"scheme_name\":\"KEY\",\n \"username\":\"admin\",\n \"identity_file\":\"-----BEGIN PRIVATE KEY-----\\nMIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAQCfJGCSdJx+qKxt\\nE4vmwdLYbFjeuYMNqC3YfB+6sWcqkkZc708zlIyl7Z3F4PE3THDWBo6gCCa3vi6E\\nL8HRHUcl8HM4iZxUt352MEJkUuUtkn5tMI5phm9r6bZS736w+AsyYawcOpI24253\\nuqPWRXv1VzFJBwk+lgBlzEuarcH7krimBfC1pJdyG7KsfPhTiwtgXA7b2Hz6p9Ub\\nuozZ9A1OigyR6QbFKJ/Fl0EsmUinRsPFkeiijF3uQuTUPl0lhty+UY99GmmRQ0+v\\nH2wKUbyh6+T4vmhBhVrBTqhCfIJrD6ZJin20AYJUxiu9SSdLq7HzMR4LnEe78/0T \\nlGG7yP0jAgMBAAECggEAG94+bRcvmnyGKVm9a4zwk8axb1tUKE2Vra3azpIna0yP\\nNtIPcAxo7tuj/9Vq2FCyB8DBNCQJR67trWdBjRGP9oRbYQC0GB/D7QV5cuETUf4v\\n1oYkwjTxCRg1veNDr9DYARwajBzzotoD68KK00h6sxVwQ4YQZ93Ttv/mE3GvIRMj\\nQN1s6VbFe7jUpEzfJO6/Mg4aRKrFEIp/5q7NRT4jwY4UBJlEC0I9zhrs4rnyIjWR\\nLpazAmugcMQ4Uj8xaIDg4rb/KfjdiitivW+6AhXd49RLm6GXncXv1hwN6wZ1Punb\\nxV8+xwt9BS5gwBuNASokjwOTswj+bxYXTsaxHPfjvQKBgQDMhsssUOhLJrohcGdR\\n3dF/jeJZ6a+GMydBhiVdWHAhx1prEcjH65o0jpWefpk3XiJVcTtdhHtU8Qamm0xV\\nVxaVd8W9LJZBRmjJ0VAzghBWzq4je3pw6JAIhVYL3bWzR74xVa9NiFXu8ZqLsJjw\\nNlEPQ9vZQZwIDUOs1p9as7PUFQKBgQDHMY+8x/YyyYRhLCsqgdynV3Lc2J5Hk9bN \\nqo604uhEAJTbHTZ7WwRAT9QNbIBJwx7j5z1m4MEUq0RFe+MDyW+ACxz+oIGrgmMe\\nVcNdvlzQHGywo3BC5CvygU1RrSnu1pqeLk9Vo5KXTz3rAr59Icw54rw7BC7b2RqY\\nSnmQUCTCVwKBgBjJ0YAagjzxgaeh3vPeJZEHGkL5fquOMZjQcGDi4hxF9CB79FC+ \\nrl7mVR3zjBBY2WJvqdlIwEXoPH0e316MgpE1BgNKjx90MCkdtFG51s8el553Tby3\\ngxV1S5t+kJIdBOEn2GpWNswR/kAl9DNQ8fweplurhwS2ztf43zF4DDiNAoGARpo1\\nhUcm53dv2XVrU2S2DgY76zVIXLx07W7fqBOpGblPCZ8AGZb4GcdxtNRZYEutnj/v \\nDpDpPuc5iptPqp7yS2MlAsdnTqAne7AQUCDSCt2YVL+JYdw4C3tzKVkEPOiJ4zks\\n24Dfy4vFuY++buHU3kuURiLEbR41g/cZwWH2tX8CgYAaXJvi9UkNlYfcIzsTqnkC\\nmEJt1keFgoD6U0VK2SWL65EL24s5bC81cVtQo6cuVRiAbKKyvcI0/qwnDqIRa9/J\\nuakA4piJcmbae9qSNRdloIYdYKT4k7DRHoh45eB7ZKdCu76gUUllOAdr8DGF6xBr\\nzHPHeBNiX4ORwTewAEf+VA==\\n-----END PRIVATE KEY-----\"\n }\n },\n \"directory_path\":\"/nsx-backups\"\n },\n \"passphrase\":\"swordfish\",\n \"inventory_summary_interval\":300\n }\n",
"x-vmw-nsx-module": "BackupConfiguration",
"x-codegen-request-body-name": "BackupConfiguration"
}
},
"/security/sensor-registration-token": {
"post": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Access Token"
],
"summary": "Create sensor registration access token",
"description": "The privileges of the registration token will be user with sensor role.",
"operationId": "CreateSensorRegistrationToken",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationToken"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/security/sensor-registration-token\n",
"x-vmw-nsx-module": "SensorRegistrationTokenEndPoint",
"x-vmw-nsx-example-response": "{\n \"token\": \"e9112e46-a54a-486f-82bb-043b89228c1b\",\n \"roles\":[\n \"sensor\"\n ]\n}\n"
}
},
"/global-infra/ipv6-dad-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"IPV6 DAD Profiles"
],
"summary": "List all IPv6 DAD profiles",
"description": "Paginated list of all IPv6 DAD profile instances\n",
"operationId": "GlobalInfraListIpv6DadProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ipv6DadProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipv6-dad-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"dad_mode\": \"LOOSE\",\n \"wait_time\": 1,\n \"ns_retries\": 3,\n \"resource_type\": \"Ipv6DadProfile\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/ipv6-dad-profiles/default\",\n \"relative_path\": \"default\",\n \"parent_path\": \"/infra/ipv6-dad-profiles/default\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1553814058782,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1553814058782,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/full-sync-action": {
"post": {
"tags": [
"Federation",
"Full Synchronization"
],
"summary": "Performs realized object actions specified in the action.",
"description": "Performs realized object actions specified in the action.",
"operationId": "FullSyncActions",
"parameters": [
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"request_full_sync",
"request_notifications_full_sync",
"abort_current_sync",
"purge_history"
]
}
},
{
"name": "site",
"in": "query",
"description": "site id",
"schema": {
"type": "string"
}
},
{
"name": "sync_type",
"in": "query",
"description": "Type of full sync being requested",
"schema": {
"type": "string",
"enum": [
"gm_to_lm_full_sync"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/full-sync-action?action=request_full_sync\nPOST https://policy.nsx.vmware.com/global-manager/api/v1/orgs/256d811c-168c-41b6-9c5c-e1672a84dcb7/projects/default--nsx-dev-test/infra/full-sync-action?action=request_notifications_full_sync&site=site1\n",
"x-vmw-nsx-module": "PolicyFullSync",
"x-vmw-nsx-example-response": "{\n \"fullsync_action_response\": \"requested full sync\",\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-server-config/status": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"DHCP",
"Statistics"
],
"summary": "Read Vpc Subnet DHCP server status",
"description": "Read Vpc Subnet DHCP server status",
"operationId": "GetVpcSubnetDhcpServerStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServerStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/subnets/subnet-1/dhcp-server-config/status\n",
"x-vmw-nsx-module": "PolicyVpcSubnetStatistics",
"x-vmw-nsx-example-response": "{\n \"active_node\": \"/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/bf80b020-2df8-11ea-986b-000c291ec83c\",\n \"stand_by_node\": \"/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/c03dadec-2df8-11ea-a4e6-000c295fbd46\",\n \"service_status\": \"UP\"\n}\n"
}
},
"/infra/traceflows/{traceflow-id}/observations": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Read traceflow observations",
"description": "Read traceflow observations for id traceflow-id. Traceflow configuration will be cleaned up by the system after two hours of inactivity. Enforcement Path is optional parameter.",
"operationId": "ListTraceflowObservations",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowObservationListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://<policy-mgr>/policy/api/v1/infra/traceflows/t1/observations\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"resource_type\": \"TraceflowObservationReceived\",\n \"sequence_no\": 0,\n \"transport_node_id\": \"b969a530-3823-11ea-9a27-5960b416cadc\",\n \"transport_node_name\": \"wdc-rdops-vm03-dhcp-29-221.eng.vmware.com\",\n \"transport_node_type\": \"ESX\",\n \"timestamp\": 1579241381499,\n \"timestamp_micro\": 1579241381499596,\n \"component_type\": \"PHYSICAL\",\n \"component_sub_type\": \"UNKNOWN\",\n \"component_name\": \"Physical\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"sequence_number\",\n \"sort_ascending\": true,\n \"cursor\": \"00011\"\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-instances/{service-instance-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Statistics"
],
"summary": "Get statistics for all runtimes associated with this PolicyServiceInstance",
"description": "Get statistics for all data NICs on all runtimes associated with this PolicyServiceInstance.\n",
"operationId": "GetPolicyServiceInstanceStatistics",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyServiceInstanceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1//infra/tier-0s/default/locale-services/default/service-instances/PSI_1/statistics\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n\"service_instance_id\": \"/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-313/service-instances/PSI-1\",\n\"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n\"instance_runtime_statistics\": [\n {\n \"runtime_id\": \"5cee6445-c62a-43bc-b3c9-2fb11f48b301\",\n \"runtime_name\": \"ServiceInsertion-NS-33c26724-d628-4f03-a689-33477ec031e9-1\",\n \"primary_runtime_stats\": true,\n \"interface_statistics\": [\n {\n \"interface_index\": 1,\n \"last_update_timestamp\": 1545396650417,\n \"rx_packets\": {\n \"multicast_broadcast\": 298943512,\n \"total\": 301217408\n },\n \"rx_bytes\": {\n \"multicast_broadcast\": 19379256222,\n \"total\": 19515689982\n },\n \"tx_packets\": {\n \"multicast_broadcast\": 298420856,\n \"dropped\": 4820,\n \"total\": 299545474\n },\n \"tx_bytes\": {\n \"multicast_broadcast\": 19348818756,\n \"total\": 19416006636\n },\n \"mac_learning\": {\n \"macs_learned\": 136\n }\n },\n {\n \"interface_index\": 2,\n \"last_update_timestamp\": 1545396650417,\n \"rx_packets\": {\n \"multicast_broadcast\": 298419043,\n \"total\": 299538836\n },\n \"rx_bytes\": {\n \"multicast_broadcast\": 19348701252,\n \"total\": 19415888832\n },\n \"tx_packets\": {\n \"multicast_broadcast\": 298945259,\n \"dropped\": 7715,\n \"total\": 301226872\n },\n \"tx_bytes\": {\n \"multicast_broadcast\": 19379369124,\n \"total\": 19515803004\n },\n \"mac_learning\": {\n \"macs_learned\": 122\n }\n }\n ]\n },\n {\n \"runtime_id\": \"fe0a2f86-7d27-41b9-ac52-5459d6bead1e\",\n \"runtime_name\": \"ServiceInsertion-NS-33c26724-d628-4f03-a689-33477ec031e9-2\",\n \"primary_runtime_stats\": false,\n \"interface_statistics\": [\n {\n \"interface_index\": 2,\n \"last_update_timestamp\": 1545396650417,\n \"rx_packets\": {\n \"multicast_broadcast\": 297799990,\n \"total\": 300072079\n },\n \"rx_bytes\": {\n \"multicast_broadcast\": 19305570996,\n \"total\": 19441896336\n },\n \"tx_packets\": {\n \"multicast_broadcast\": 297227511,\n \"dropped\": 19744270,\n \"total\": 318084316\n },\n \"tx_bytes\": {\n \"multicast_broadcast\": 19272225186,\n \"total\": 19338977286\n },\n \"mac_learning\": {\n \"macs_learned\": 114\n }\n },\n {\n \"interface_index\": 1,\n \"last_update_timestamp\": 1545396650417,\n \"rx_packets\": {\n \"multicast_broadcast\": 297226991,\n \"total\": 298339522\n },\n \"rx_bytes\": {\n \"multicast_broadcast\": 19272191538,\n \"total\": 19338943398\n },\n \"tx_packets\": {\n \"multicast_broadcast\": 297800743,\n \"dropped\": 17783194,\n \"total\": 317856028\n },\n \"tx_bytes\": {\n \"multicast_broadcast\": 19305620274,\n \"total\": 19441945734\n },\n \"mac_learning\": {\n \"macs_learned\": 124\n }\n }\n ]\n }\n]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}/complete": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Get a preview of a configuration after publish of a draft",
"description": "Get a preview of a configuration which will be present after publish of\na specified draft. The response essentially is a hierarchical payload\ncontaining the configuration, which will be in active after a specified\ndraft gets published onto current configuration.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPreviewOfConfigurationAfterPublishOfDraft",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Infra"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft/complete\n",
"x-vmw-nsx-module": "PolicyDraft",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Infra\",\n \"id\": \"infra\",\n \"display_name\": \"infra\",\n \"path\": \"/infra\",\n \"children\": [\n {\n \"children\": [\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-1\",\n \"display_name\": \"app-section-1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 1,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"target_type\": \"Domain\",\n \"resource_type\": \"ChildResourceReference\",\n \"id\": \"default\",\n \"marked_for_delete\": false,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/global-infra/context-profiles": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Get PolicyContextProfiles",
"description": "Get all PolicyContextProfiles\n",
"operationId": "GlobalInfraListPolicyContextProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/\n {\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\":\"PolicyContextProfile\",\n \"display_name\":\"testPolicyContextProfile\",\n \"description\":\"Test Policy Context Profile\",\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\":[\n \"TLS\"\n ],\n \"datatype\":\"STRING\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"ENCRYPTION_ALGORITHM\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\":\"STRING\"\n }\n ],\n },\n {\n \"key\":\"DOMAIN_NAME\",\n \"value\": [\n \"*.office365.com\"\n ],\n \"datatype\":\"STRING\"\n }\n ]\n }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyContextProfile"
}
},
"/global-infra/tier-1s/{tier1-id}/locale-services/{locale-services-id}/session-timer-profile-bindings/{session-timer-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices.\n",
"operationId": "GlobalInfraGetTier1LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/subnets": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Security",
"Groups",
"Group Members"
],
"summary": "Get subnets that belong to this VPC Group",
"description": "Get subnets that belong to this VPC Group\n",
"operationId": "GetVpcGroupSubnetMembers",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/groups/g1/members/subnets?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyVpcGroup",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"id\": \"segment-1\",\n \"display_name\": \"segment-1\",\n \"path\": \"/infra/segments/segment-1\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"target_display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/global-managers": {
"get": {
"tags": [
"Federation",
"Global Managers"
],
"summary": "List Global Managers",
"description": "List Global Managers under Infra.\n",
"operationId": "GlobalInfraListInfraGlobalManagers",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalManagerListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/global-manager/api/v1/global-infra/global-managers\n",
"x-vmw-nsx-module": "PolicySiteGM",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 2,\n \"results\" : [\n {\n \"resource_type\": \"GlobalManager\",\n \"id\": \"london\",\n \"gm_id\": \"aad93dd9-ea71-41d7-be0d-1b1fca616660\",\n \"display_name\": \"London GM\",\n \"path\": \"/infra/global-managers/london\",\n \"parent_path\": \"/infra/global-managers/london\",\n \"relative_path\": \"london\",\n \"mode\": \"ACTIVE\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n },\n {\n \"resource_type\": \"GlobalManager\",\n \"id\": \"Paris\",\n \"gm_id\": \"dfd93dd9-ea71-41d7-be0d-1b1fca616660\",\n \"display_name\": \"Paris GM\",\n \"path\": \"/infra/global-managers/Paris\",\n \"parent_path\": \"/infra/global-managers/Paris\",\n \"relative_path\": \"Paris\",\n \"mode\": \"STANDBY\",\n \"connection_info\": [{\n \"fqdn\": \"10.190.201.163\"\n }],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/lb-services/{lb-service-id}/detailed-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Usage",
"Status"
],
"summary": "Get LBService status information",
"description": "Get LBService detailed status information.\n- no enforcement point path specified: Information will be aggregated from\neach enforcement point.\n- {enforcement_point_path}: Information will be retrieved only from the\ngiven enforcement point.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "GetLBServiceStatus",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_instance_details",
"in": "query",
"description": "Flag to indicate whether include detail information",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_ids",
"in": "query",
"description": "The UUIDs of transport nodes",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateLBServiceStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyLBStatistics"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Security",
"E-W Firewall"
],
"summary": "Revise the positioning of VPC E-W Firewall rule",
"description": "This is used to re-order a rule within a VPC security policy.\n",
"operationId": "ReviseVpcSecurityRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/security-policies/sp-3/rules/rule-4?action=revise&anchor_path=/orgs/default/projects/project-1/vpcs/vpc-1/security-policies/sp-3/rules/rule-1&operation=insert_after\n{\n \"action\": \"ALLOW\",\n \"resource_type\": \"Rule\",\n \"id\": \"rule-1\",\n \"display_name\": \"rule-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"ANY\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"profiles\": [\n \"/infra/context-profiles/360ANTIV\"\n ]\n}\n",
"x-vmw-nsx-module": "PolicyVpcPolicy",
"x-vmw-nsx-example-response": "{\n \"action\": \"ALLOW\",\n \"resource_type\": \"Rule\",\n \"id\": \"rule-4\",\n \"display_name\": \"rule-1\",\n \"path\": \"/orgs/default/projects/test-project/vpcs/vpc-1/security-policies/sp-3/rules/rule-4\",\n \"relative_path\": \"rule-4\",\n \"parent_path\": \"/orgs/default/projects/test-project/vpcs/vpc-1/security-policies/sp-3\",\n \"remote_path\": \"\",\n \"unique_id\": \"00000000-0000-0000-0000-000000009194\",\n \"realization_id\": \"00000000-0000-0000-0000-000000009194\",\n \"owner_id\": \"54d15ea1-54f8-4218-a084-cf0dc5b929f5\",\n \"origin_site_id\": \"54d15ea1-54f8-4218-a084-cf0dc5b929f5\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"rule_id\": 9194,\n \"sequence_number\": 150,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"ANY\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"profiles\": [\n \"/infra/context-profiles/360ANTIV\"\n ],\n \"logged\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"disabled\": false,\n \"direction\": \"IN_OUT\",\n \"ip_protocol\": \"IPV4_IPV6\",\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_time\": 1683801392719,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1683801392719,\n \"_last_modified_user\": \"admin\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "Rule"
}
},
"/aaa/role-bindings?action=delete_stale_bindings": {
"post": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Delete all stale role assignments",
"description": "Delete all stale role assignments",
"operationId": "DeleteAllStaleRoleBindings",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_id",
"in": "query",
"description": "Identity source ID",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_type",
"in": "query",
"description": "Identity source type",
"schema": {
"type": "string",
"enum": [
"VIDM",
"LDAP",
"OIDC"
]
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "User/Group name",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "path",
"in": "query",
"description": "Exact path of the context",
"schema": {
"type": "string"
}
},
{
"name": "role",
"in": "query",
"description": "Role ID",
"schema": {
"type": "string"
}
},
{
"name": "root_path",
"in": "query",
"description": "Prefix path of the context",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type",
"schema": {
"type": "string",
"enum": [
"remote_user",
"remote_group",
"local_user",
"principal_identity"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/aaa/role-bindings?action=delete_stale_bindings\n",
"x-vmw-nsx-module": "AAA",
"x-vmw-nsx-example-response": "200 OK"
}
},
"/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Statistics"
],
"summary": "Get L2VPN session statistics under Tier-0",
"description": "- no enforcement point path specified: statistics are evaluated on each enforcement point.\n- an enforcement point path is specified: statistics are evaluated only on the given\nenforcement point.\n- source=realtime: statistics are fetched realtime from the enforcement point.\n- source=cached: cached statistics from the enforcement point are returned.\n",
"operationId": "GetTier0VpnL2VpnSessionStatistics",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VPNSessionStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/l2vpn-services/default/sessions/stretched-pa-site/statistics\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/tier-0s/{tier-0-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Gateways"
],
"summary": "Read Tier-0",
"description": "Read Tier-0",
"operationId": "ReadTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Tier0\",\n \"id\": \"vmc_prv\",\n \"display_name\": \"/infra/tier-0s/vmc_prv\",\n \"path\": \"/infra/tier-0s/vmc_prv\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"vmc_prv\",\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"transit_subnets\": [ \"10.2.3.0/24\" ],\n \"force_whitelisting\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Gateways"
],
"summary": "Create or update a Tier-0",
"description": "If a Tier-0 with the tier-0-id is not already present, create a new\nTier-0. If it already exists, replace the Tier-0 instance with the new object.\n",
"operationId": "CreateOrReplaceTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv\n{\n \"transit_subnets\": [ \"10.2.3.0/24\" ],\n \"ha_mode\":\"ACTIVE_STANDBY\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Tier0\",\n \"id\": \"vmc_prv\",\n \"display_name\": \"/infra/tier-0s/vmc_prv\",\n \"path\": \"/infra/tier-0s/vmc_prv\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"vmc_prv\",\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"transit_subnets\": [ \"10.2.3.0/24\" ],\n \"force_whitelisting\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "Tier0"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Gateways"
],
"summary": "Delete Tier-0",
"description": "Delete Tier-0",
"operationId": "DeleteTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Gateways"
],
"summary": "Create or update a Tier-0",
"description": "If a Tier-0 with the tier-0-id is not already present, create a new\nTier-0. If it already exists, update the Tier-0 for specified attributes.\n",
"operationId": "PatchTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv\n{\n \"transit_subnets\": [ \"10.2.3.0/24\" ],\n \"ha_mode\":\"ACTIVE_STANDBY\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "Tier0"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments (Fixed)"
],
"summary": "List all effective profiles for segment",
"description": "List all effective profiles for this segment on given enforcement point.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListSegmentEffectiveProfiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectiveProfilesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/tier1-ls/effective-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Get IPSec VPN Session",
"description": "Get IPSec VPN session without sensitive data for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyBasedIPSecVpnSession\",\n \"description\": \"Policy based vpn session 1\",\n \"display_name\": \"pbs-1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"rules\" : [ {\n \"resource_type\": \"IPSecVpnRule\",\n \"id\": \"custom-rule-1\",\n \"path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1/rules/custom-rule-1\",\n \"parent_path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\",\n \"relative_path\": \"custom-rule-1\",\n \"sources\": [\n {\n \"subnet\" : \"10.0.2.0/24\"\n },\n {\n \"subnet\" : \"10.0.1.0/24\"\n }\n ],\n \"destinations\" : [\n {\n \"subnet\" : \"10.1.1.0/24\"\n }\n ],\n \"enabled\" : true,\n \"logged\" : true,\n \"action\": \"PROTECT\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n } ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Create or fully replace IPSec VPN session",
"description": "Create or fully replace IPSec VPN session for a ipsec vpn\nservice under Tier-1.\nRevision is optional for creation and required for update.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdateTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1\n{\n \"resource_type\": \"RouteBasedIPSecVpnSession\",\n \"display_name\" : \"rbs-1\",\n \"description\" : \"Route based vpn session 1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"psk\" : \"test\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"tunnel_interfaces\" : [ {\n \"ip_subnets\" : [ {\n \"ip_addresses\" : [ \"169.90.50.1\" ],\n \"prefix_length\" : 30\n } ],\n \"_revision\" : 2,\n } ],\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"RouteBasedIPSecVpnSession\",\n \"display_name\" : \"rbs-1\",\n \"description\" : \"Route based vpn session 1\",\n \"path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1\",\n \"parent_path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default\",\n \"relative_path\": \"rbs-1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"psk\" : \"test\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"tunnel_interfaces\" : [ {\n \"resource_type\" : \"IPSecVpnTunnelInterface\",\n \"path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1/interfaces/default-tunnel-interface\",\n \"parent_path\": \"/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/rbs-1\",\n \"relative_path\": \"default-tunnel-interface\",\n \"ip_subnets\" : [ {\n \"ip_addresses\" : [ \"169.90.50.1\" ],\n \"prefix_length\" : 30\n } ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 2,\n } ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 0\n}\n",
"x-codegen-request-body-name": "IPSecVpnSession"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Delete IPSec VPN session",
"description": "Delete IPSec VPN session for a given ipsec-vpn service under Tier-1.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Create or patch an IPSec VPN session",
"description": "Create or patch an IPSec VPN session for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrPatchTier1VpnIPSecVpnSession",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnSession"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/sessions/pbs-1\n{\n \"resource_type\": \"PolicyBasedIPSecVpnSession\",\n \"description\": \"Policy based vpn session 1\",\n \"display_name\": \"pbs-1\",\n \"enabled\" : true,\n \"connection_initiation_mode\" : \"INITIATOR\",\n \"authentication_mode\" : \"PSK\",\n \"tunnel_profile_path\" : \"/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile\",\n \"dpd_profile_path\" : \"/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile\",\n \"ike_profile_path\" : \"/infra/ipsec-vpn-ike-profiles/custom-ike-profile\",\n \"local_endpoint_path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"psk\" : \"test\",\n \"peer_address\" : \"2.1.4.1\",\n \"peer_id\" : \"2.1.4.1\",\n \"rules\" : [ {\n \"resource_type\": \"IPSecVpnRule\",\n \"id\": \"custom-rule-1\",\n \"sources\": [\n {\n \"subnet\" : \"10.0.2.0/24\"\n },\n {\n \"subnet\" : \"10.0.1.0/24\"\n }\n ],\n \"destinations\" : [\n {\n \"subnet\" : \"10.1.1.0/24\"\n }\n ],\n \"enabled\" : true,\n \"logged\" : true,\n \"action\": \"PROTECT\"\n } ]\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnSession"
}
},
"/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Read gateway policy",
"description": "Read gateway policy for a domain.\n",
"operationId": "ReadGatewayPolicyForDomain",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/default\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"default\",\n \"display_name\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"default\",\n \"category\": \"SharedPreRules\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n }\n ],\n \"sequence_number\": 13,\n \"internal_sequence_number\": 20013,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061797,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 5\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Update gateway policy",
"description": "Update the gateway policy for a domain. This is a full replace.\nAll the rules are replaced.\nPerformance Note: If you want to edit several rules in a gateway policy,\nuse this API. It will perform better than several individual rule APIs.\nJust pass all the rules which you wish to edit as embedded rules to it.\n",
"operationId": "CreateOrReplaceGatewayPolicyForDomain",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/default\n{\n \"category\": \"SharedPreRules\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_revision\": 3\n }\n ],\n \"_revision\": 4\n}\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"default\",\n \"display_name\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"default\",\n \"category\": \"SharedPreRules\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n }\n ],\n \"sequence_number\": 0,\n \"internal_sequence_number\": 20000,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061797,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 5\n}\n",
"x-codegen-request-body-name": "GatewayPolicy"
},
"delete": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Delete GatewayPolicy",
"description": "Delete GatewayPolicy",
"operationId": "DeleteGatewayPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/map1\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall"
},
"patch": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Update gateway policy",
"description": "Update the gateway policy for a domain. This is a full replace.\nAll the rules are replaced.\nPerformance Note: If you want to edit several rules in a gateway policy\nuse this API. It will perform better than several individual rule APIs.\nJust pass all the rules which you wish to edit as embedded rules to it.\n",
"operationId": "PatchGatewayPolicyForDomain",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/default\n{\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"category\": \"SharedPreRules\",\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ]\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-codegen-request-body-name": "GatewayPolicy"
}
},
"/global-infra/tier-0s/{tier-0-id}/number-of-routes": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing"
],
"summary": "Get total number of IPv4 or IPv6 routes on a Tier0",
"description": "Get total number of IPv4 or IPv6 routes on a Tier0\n",
"operationId": "GlobalInfraGetTier0NumberOfRoutes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_child_vrf",
"in": "query",
"description": "Count all the child VRF routes or not.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0NumberOfRoutesResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://<policy-mgr>/policy/api/v1/infra/tier-0s/pepsi/number-of-routes?edge_path=/infra/sites/default/enforcement-points/default/edge-clusters//edge-nodes/0\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/global-infra/sites/{site-id}/enforcement-points": {
"get": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "List enforcementpoints under Site",
"description": "Paginated list of all enforcementpoints under Site.\n",
"operationId": "GlobalInfraListEnforcementPointForSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnforcementPointListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"EnforcementPoint\",\n \"id\": \"nsxt-ep\",\n \"display_name\": \"/infra/sites/default/enforcement-points/nsxt-ep\",\n \"path\": \"/infra/sites/default/enforcement-points/nsxt-ep\",\n \"parent_path\": \"/infra/sites/default\",\n \"relative_path\": \"nsxt-ep\",\n \"connection_info\": {\n \"resource_type\": \"NSXTConnectionInfo\",\n \"enforcement_point_address\": \"10.192.201.163\",\n \"thumbprint\": \"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\"\n },\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262753660,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n }\n ]\n}\n"
}
},
"/infra/segments/{segment-id}/gateway-interface-statistics/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get statistics for downlink router port on tier-0 router",
"description": "Segment ID is the ID of the segment that is connected to the the tier-0\n",
"operationId": "GetDownlinkPortStatisticsSummaryForInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatisticsSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER1_DOWNLINK_SWITCH/gateway-interface-statistics/summary\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_policy_path\": \"/infra/segments/TIER1_DOWNLINK_SWITCH\",\n \"last_update_timestamp\": 1591854157020,\n \"rx\": {\n \"total_bytes\": 314886932,\n \"total_packets\": 678919,\n \"dropped_packets\": 151381\n },\n \"tx\": {\n \"total_bytes\": 75554376,\n \"total_packets\": 1130225,\n \"dropped_packets\": 151381\n },\n \"logical_router_port_id\": \"cbac60fb-841f-4d29-951b-500f527bda34\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Read DHCP server status",
"description": "Read DHCP server status",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadDhcpServerStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServerStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/status?connectivity_path=/infra/tier-1s/it_t1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"active_node\": \"/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/bf80b020-2df8-11ea-986b-000c291ec83c\",\n \"stand_by_node\": \"/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/c03dadec-2df8-11ea-a4e6-000c295fbd46\",\n \"service_status\": \"UP\"\n}\n"
}
},
"/infra/firewall-identity-stores/{firewall-identity-store-id}/ldap-servers/{ldap-server-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Get a specific LDAP server for a given Firewall Identity store",
"description": "Get a specific LDAP server for a given Firewall Identity store\n
\n
Use the following Policy API -
GET /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>",
"operationId": "ReadFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1/ldap-servers/01ad13c6-23c1-4175-ad3f-881eac8e45ef\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"DirectoryLdapServer\",\n \"id\": \"01ad13c6-23c1-4175-ad3f-881eac8e45ef\",\n \"display_name\": \"nimbus test LDAP\",\n \"protocol\": \"LDAP\",\n \"port\": 389,\n \"host\": \"10.161.34.143\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"enabled\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1521154561239,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1521154779064,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Update a LDAP server for Firewall Identity store",
"description": "Update a LDAP server for Firewall Identity store\n
\n
Use the following Policy API -
PUT /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>",
"operationId": "CreateOrReplaceFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServer"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1/ldap-servers/ldap-server-1\n{\n \"host\": \"10.161.34.143\",\n \"username\": \"dummy\",\n \"password\": \"dummy\",\n \"display_name\": \"nimbus test LDAP\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"DirectoryLdapServer\",\n \"id\": \"ldap-server-1\",\n \"display_name\": \"nimbus test LDAP\",\n \"protocol\": \"LDAP\",\n \"port\": 389,\n \"host\": \"10.161.34.143\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"enabled\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1521154561239,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1521154779064,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "DirectoryLdapServer"
},
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"LDAP Servers"
],
"summary": "Test a LDAP server connection for directory domain",
"description": "The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.",
"operationId": "TestFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "LDAP server test requested",
"required": true,
"schema": {
"type": "string",
"enum": [
"CONNECTIVITY"
]
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/756c3f9f-c03a-43fc-9414-400a1891a239/ldap-servers/01ad13c6-23c1-4175-ad3f-881eac8e45ef?action=CONNECTIVITY\n",
"x-vmw-nsx-module": "PolicyIdentity"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Delete a LDAP server for Firewall Identity store",
"description": "Delete a LDAP server for Firewall Identity store\n
\n
Use the following Policy API -
DELETE /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>",
"operationId": "DeleteFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1/ldap-servers/01ad13c6-23c1-4175-ad3f-881eac8e45ef\n",
"x-vmw-nsx-module": "PolicyIdentity"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Ldap-Server"
],
"summary": "Create a LDAP server for Firewall Identity store",
"description": "More than one LDAP server can be created and only one LDAP\nserver is used to synchronize directory objects. If more\nthan one LDAP server is configured, NSX will try all the\nservers until it is able to successfully connect to one.\n\n
\n
Use the following Policy API -
PATCH /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>",
"operationId": "CreateOrPatchFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ldap-server-id",
"in": "path",
"description": "LDAP server identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServer"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1/ldap-servers/01ad13c6-23c1-4175-ad3f-881eac8e45ef\n{\n \"host\": \"10.161.34.143\",\n \"username\": \"dummy\",\n \"password\": \"dummy\",\n \"display_name\": \"nimbus LDAP\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"port\": 389,\n \"protocol\": \"LDAP\"\n}\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"DirectoryLdapServer\",\n \"id\": \"01ad13c6-23c1-4175-ad3f-881eac8e45ef\",\n \"display_name\": \"nimbus LDAP\",\n \"protocol\": \"LDAP\",\n \"port\": 389,\n \"host\": \"10.161.34.143\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"enabled\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1521154561239,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1521154561239,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "DirectoryLdapServer"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/statistics/virtual-machines": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get effective VMs for the Group",
"description": "Get the effective VM membership for the Group. This API also gives some VM\ndetails such as VM name, IDs and the current state of the VMs.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGroupVMStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealizedVirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/statistics/virtual-machines?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"RealizedVirtualMachine\",\n \"id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"1-vm_ubuntu_1404_srv_64-local-586-bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"path\": \"/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564de333-15ac-de52-da90-974fe099a17b\",\n \"parent_path\": \"/infra/realized-state/enforcement-points/nsx-1\",\n \"relative_path\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"intent_reference\": [],\n \"realization_specific_identifier\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"alarms\": [],\n \"state\": \"REALIZED\",\n \"runtime_status\": \"UNKNOWN\",\n \"compute_ids\": [\n \"moIdOnHost:1\",\n \"hostLocalId:1\",\n \"locationId:564de333-15ac-de52-da90-974fe099a17b\",\n \"instanceUuid:bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"externalId:564de333-15ac-de52-da90-974fe099a17b\",\n \"biosUuid:564de333-15ac-de52-da90-974fe099a17b\"\n ],\n \"power_state\": \"vm_running\",\n \"_create_user\": \"system\",\n \"_create_time\": 1519383616259,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1519383616259,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Locale Services"
],
"summary": "Read Tier-0 locale-services",
"description": "Read Tier-0 locale-services",
"operationId": "ReadTier0LocaleServices",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/palo_alto\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LocaleServices\",\n \"id\": \"palo_alto\",\n \"display_name\": \"Palo Alto\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/palo_alto\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"palo_alto\",\n \"route_redistribution_types\": [ \"TIER0_STATIC\", \"TIER0_NAT\" ],\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Locale Services"
],
"summary": "Create or update a Tier-0 locale-services",
"description": "If a Tier-0 locale-services with the locale-services-id is not already\npresent, create a new locale-services. If it already exists, replace the\nTier-0 locale-services instance with the new object.\n",
"operationId": "CreateOrReplaceTier0LocaleServices",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/palo_alto\n{\n \"route_redistribution_types\": [ \"TIER0_STATIC\", \"TIER0_NAT\" ],\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LocaleServices\",\n \"id\": \"palo_alto\",\n \"display_name\": \"Palo Alto\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/palo_alto\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"palo_alto\",\n \"route_redistribution_types\": [ \"TIER0_STATIC\", \"TIER0_NAT\" ],\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "LocaleServices"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Locale Services"
],
"summary": "Delete Tier-0 locale-services",
"description": "Delete Tier-0 locale-services",
"operationId": "DeleteTier0LocaleServices",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/palo_alto\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Locale Services"
],
"summary": "Create or update a tier-0 locale-services",
"description": "If a Tier-0 locale-services with the locale-services-id is not already\npresent, create a new locale-services. If it already exists, update\nTier-0 locale-services with specified attributes.\n",
"operationId": "PatchTier0LocaleServices",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/palo_alto\n{\n \"route_redistribution_types\": [ \"TIER0_STATIC\", \"TIER0_NAT\" ],\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ]\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "LocaleServices"
}
},
"/aaa/ldap-identity-sources": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"LDAP Identity Sources"
],
"summary": "List LDAP identity sources",
"description": "Return a list of all configured LDAP identity sources.",
"operationId": "ListLdapIdentitySources",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapIdentitySourceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET /policy/api/v1/aaa/ldap-identity-sources\n",
"x-vmw-nsx-module": "LdapIdentitySources",
"x-vmw-nsx-example-response": "200 OK\n{\n \"result_count\": 1,\n \"results\": [\n {\n \"id\": \"airius-ad\",\n \"resource_type\": \"ActiveDirectoryIdentitySource\",\n \"display_name\": \"Airius LDAP\",\n \"domain_name\": \"airius.com\",\n \"base_dn\": \"DC=airius, DC=com\",\n \"ldap_servers\": [\n \"url\": \"ldap://ldap-vip01.corp.airius.com\",\n \"use_starttls\": true,\n \"bind_identity\": \"nsxint@airius.com\",\n \"certificates\": [\n \"BEGIN_CERTIFICATE <certificate> END_CERTIFICATE\",\n ]\n ],\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1531939962695,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1531936487738,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-node-collections/{transport-node-collection-id}?action=remove_nsx": {
"post": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Node Collections"
],
"summary": "Uninstall NSX from the specified Transport Node Collection",
"description": "This API uninstalls NSX applied to the Transport Node Collection with the ID corresponding to the one specified in the request.",
"operationId": "RemoveNSXOnTransportNodeCollection",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transport-node-collection-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/TNC1?action=remove_nsx\n",
"x-vmw-nsx-module": "HostTransportNodeCollection"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/ids-summary": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Dashboard"
],
"summary": "Get the summary of the intrusions that were detected.",
"description": "Get the summary of all the intrusions that are detected grouped by signature\nwith details including signature name, id, severity, attack type, protocol,\nfirst and recent occurence, and affected users and VMs.\nThe following filter criteria are supported: attack target, attack type,\ngateway name, IP address, product affected, signature ID and VM name.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPolicyIdsDashboardSummary",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "context",
"in": "query",
"description": "Tenancy Context of the API request",
"schema": {
"type": "string",
"enum": [
"ALL_PROJECTS"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsEventDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsSummaryListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-summary\n {\n \"filters\": [\n {\n \"field_names\": \"signature_detail.signature_id\",\n \"value\": \"4010643\"\n }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyIDSMetrics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"signature_id\": 4010643,\n \"total_count\": 87,\n \"affected_vm_count\": 1,\n \"user_details\": {\n \"count\": 0,\n \"user_list\": []\n },\n \"rule_id\": 1001,\n \"is_rule_valid\": true,\n \"idsflow_details\": {\n \"source_ip\": \"192.168.56.150\",\n \"source_port\": 49170,\n \"destination_ip\": \"178.33.233.154\",\n \"destination_port\": 80,\n \"protocol\": \"TCP\",\n \"profile_id\": \"491B2D21-4CEA-48E4-A7C0-98D5DDFE65E3-05-26T18:19491B2D214CEA48E4A7C098D5DDFE65E3\",\n \"rule_id\": 1001,\n \"action_type\": \"ALERT\",\n \"local_vm_ip\": \"192.168.56.150\",\n \"client_ip\": \"192.168.56.150\"\n },\n \"signature_metadata\": {\n \"resource_type\": \"IdsSignature\",\n \"signature_id\": 4010643,\n \"name\": \"ET TROJAN [eSentire] Win32/GandCrab v4/5 Ransomware CnC Activity\",\n \"class_type\": \"trojan-activity\",\n \"signature_revision\": 4,\n \"signature_severity\": \"Major\",\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"0.0\",\n \"tag\": [\n \"Ransomware\"\n ],\n \"action\": \"alert\",\n \"protocol\": \"http\",\n \"direction\": \"$HOME_NET any -> $EXTERNAL_NET any\",\n \"flow\": \"\",\n \"policy\": [\n \"suricata-ids\"\n ],\n \"type\": [\n \"suricata\"\n ],\n \"affected_product\": \"Windows_XP_Vista_7_8_10_Server_32_64_Bit\",\n \"performance_impact\": \"Low\",\n \"enabled\": true,\n \"attack_target\": \"Client_Endpoint\",\n \"malware_family\": \"GandCrab\",\n \"severity\": \"HIGH\",\n \"urls\": []\n },\n \"first_occurence\": 1590516802000,\n \"latest_occurence\": 1590517147000,\n \"resource_type\": \"IDSEvent\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"displayName\",\n \"sort_ascending\": false,\n \"cursor\": \"1\"\n }\n",
"x-codegen-request-body-name": "PolicyIdsEventDataRequest"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"BGP"
],
"summary": "Get BGP neighbor advertised routes in CSV format",
"description": "Returns routes advertised by BGP neighbor from all edge transport nodes on which\nthis neighbor is currently enabled in CSV format. Routes from all enforcement points are returned.\n",
"operationId": "GetTier0BgpNeighborAdvertisedRoutesInCsvFormat",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "neighbor-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "Number of routes to retrieve",
"schema": {
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/BgpNeighborRouteDetailsInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/defalt/bgp/neighbors/to-onprem/advertised-routes?format=csv&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n logical_router_id,neighbor_id,neighbor_address,transport_node_id,source_address,network,next_hop,local_pref,weight,med,as_path\n \"3546b561-fcc6-4292-a97a-4caa611b995d\",\"d56e64af-4329-4761-9bf7-39e0f68d7732\",40.40.40.10,\"c2ae8904-3e5f-11e9-b335-020006f72dcc\",40.40.40.1,2.1.4.0/24,40.40.40.10,100,0,1,\" 1000 !\"\n \"3546b561-fcc6-4292-a97a-4caa611b995d\",\"d56e64af-4329-4761-9bf7-39e0f68d7732\",40.40.40.10,\"c2ae8904-3e5f-11e9-b335-020006f72dcc\",40.40.40.1,10.160.64.0/19,40.40.40.10,100,0,1,\" 1000 !\"\n \"3546b561-fcc6-4292-a97a-4caa611b995d\",\"d56e64af-4329-4761-9bf7-39e0f68d7732\",40.40.40.10,\"c2ae8904-3e5f-11e9-b335-020006f72dcc\",40.40.40.1,40.40.40.0/24,40.40.40.10,100,0,1,\" 1000 !\"\n \"3546b561-fcc6-4292-a97a-4caa611b995d\",\"d56e64af-4329-4761-9bf7-39e0f68d7732\",40.40.40.10,\"c2ae8904-3e5f-11e9-b335-020006f72dcc\",40.40.40.1,90.90.90.0/24,40.40.40.10,100,0,1,\" 1000 !\"\n}\n"
}
},
"/infra/ipfix-dfw-profiles": {
"get": {
"tags": [
"Policy",
"Monitoring",
"IPFIX",
"Firewall IPFIX Profiles"
],
"summary": "List IPFIX DFW Profile",
"description": "API provides list IPFIX DFW profiles available on\nselected logical DFW.\n",
"operationId": "ListIPFIXDFWProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPFIXDFWProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipfix-dfw-profiles/\n",
"x-vmw-nsx-module": "PolicyIPFIXDFW",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"ipfix_dfw_collector_profile_path\": \"/infra/ipfix-dfw-collector-profiles/profile1\",\n \"active_flow_export_timeout\": 40,\n \"observation_domain_id\": 344,\n \"priority\": 770,\n \"resource_type\": \"IPFIXDFWProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"profile1\",\n \"path\": \"/infra/ipfix-dfw-profiles/profile1\",\n \"relative_path\": \"profile1\",\n \"parent_path\": \"/infra/ipfix-dfw-profiles/profile1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1545257663086,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1545257663086,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/segments/{segment-id}/arp-proxy": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments"
],
"summary": "Get downlink port Address Resolution Protocol Proxies for infra segment",
"description": "Returns ARP proxy table for downlink port on connected to the segment\n",
"operationId": "GlobalInfraGetDownlinkPortArpProxiesForInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/segments/test-segment/arp-proxy\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/virtual-machines": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Security",
"Groups",
"Group Members"
],
"summary": "Get Virtual machines that belong to this VPC Group",
"description": "Get Virtual machines that belong to this VPC Group.\nThis API is applicable for Groups containing VirtualMachine,member type.\nFor Groups containing other member types,an empty list is returned.\n",
"operationId": "GetVpcGroupVMMembers",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealizedVirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/groups/g1/members/virtual-machines?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyVpcGroup",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"RealizedVirtualMachine\",\n \"id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"1-vm_ubuntu_1404_srv_64-local-586-bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"path\": \"/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564de333-15ac-de52-da90-974fe099a17b\",\n \"parent_path\": \"/infra/realized-state/enforcement-points/nsx-1\",\n \"relative_path\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"intent_reference\": [],\n \"realization_specific_identifier\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"alarms\": [],\n \"state\": \"REALIZED\",\n \"runtime_status\": \"UNKNOWN\",\n \"compute_ids\": [\n \"moIdOnHost:1\",\n \"hostLocalId:1\",\n \"locationId:564de333-15ac-de52-da90-974fe099a17b\",\n \"instanceUuid:bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"externalId:564de333-15ac-de52-da90-974fe099a17b\",\n \"biosUuid:564de333-15ac-de52-da90-974fe099a17b\"\n ],\n \"power_state\": \"vm_running\",\n \"_create_user\": \"system\",\n \"_create_time\": 1519383616259,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1519383616259,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-node-collections/{transport-node-collection-id}?action=retry_profile_realization": {
"post": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Node Collections"
],
"summary": "Retry the process on applying transport node profile",
"description": "This API is relevant for compute collection on which vLCM is enabled. This API should be invoked to retry the realization of transport node profile on the compute collection. This is useful when profile realization had failed because of error in vLCM. This API has no effect if vLCM is not enabled on the computer collection.",
"operationId": "RetryHostTransportNodeCollectionRealization",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transport-node-collection-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/TNCId1?action=retry_profile_realization\n",
"x-vmw-nsx-module": "HostTransportNodeCollection"
}
},
"/infra/igmp-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Multicast Profiles"
],
"summary": "List Igmp Profile",
"description": "List all igmp profile.\n",
"operationId": "ListPolicyIgmpProfile",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIgmpProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyMulticast"
}
},
"/infra/settings/firewall/security/intrusion-services/profiles": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "List IDS profiles",
"description": "List intrusion detection profiles.\n",
"operationId": "ListIdsProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"profile_severity\" : [\n \"CRITICAL\"\n ],\n \"criteria\": [\n {\n \"filter_name\": \"CVSS\",\n \"filter_value\": [\n \"CRITICAL\"\n ],\n \"resource_type\": \"IdsProfileFilterCriteria\"\n },\n {\n \"operator\": \"AND\",\n \"resource_type\": \"IdsProfileConjunctionOperator\"\n },\n {\n \"filter_name\": \"PRODUCT_AFFECTED\",\n \"filter_value\": [\n \"NONE\"\n ],\n \"resource_type\": \"IdsProfileFilterCriteria\"\n },\n {\n \"operator\": \"AND\",\n \"resource_type\": \"IdsProfileConjunctionOperator\"\n },\n {\n \"filter_name\": \"ATTACK_TARGET\",\n \"filter_value\": [\n \"windows\"\n ],\n \"resource_type\": \"IdsProfileFilterCriteria\"\n },\n {\n \"operator\": \"AND\",\n \"resource_type\": \"IdsProfileConjunctionOperator\"\n },\n {\n \"filter_name\": \"ATTACK_TYPE\",\n \"filter_value\": [\n \"attempted-user\"\n ],\n \"resource_type\": \"IdsProfileFilterCriteria\"\n }\n ],\n \"resource_type\": \"IdsProfile\",\n \"id\": \"2\",\n \"display_name\": \"2\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/profiles/2\",\n \"relative_path\": \"2\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"10819d88-1414-4ea8-b351-4cdca35f5cad\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1586949186291,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1586949186297,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"profile_severity\" : [\n \"CRITICAL\"\n ],\n \"resource_type\": \"IdsProfile\",\n \"id\": \"DefaultIDSProfile\",\n \"display_name\": \"DefaultIDSProfile\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\",\n \"relative_path\": \"DefaultIDSProfile\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"867c709f-20d2-4977-ad00-52b1e0e64ab2\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1586422754804,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1586422754809,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"profile_severity\" : [\n \"CRITICAL\"\n ],\n \"criteria\": [\n {\n \"filter_name\": \"CVSS\",\n \"filter_value\": [\n \"0.0\"\n ],\n \"resource_type\": \"IdsProfileFilterCriteria\"\n }\n ],\n \"resource_type\": \"IdsProfile\",\n \"id\": \"test-profile\",\n \"display_name\": \"test-profile\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/profiles/test-profile\",\n \"relative_path\": \"test-profile\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"4e874f1e-62f7-40f5-93dc-65b915a557a9\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1586765213098,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1586765213102,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 3,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments"
],
"summary": "Get downlink port Address Resolution Protocol Proxies for tier-1 segment in CSV",
"description": "Returns ARP proxy table for downlink port on connected to the segment in CSV\n",
"operationId": "GlobalInfraGetDownlinkPortArpProxiesForTier1SegmentInCsv",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s//segments/test-segment/arp-proxy?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "TODO smanikarnike\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Read DHCP static binding",
"description": "Read DHCP static binding",
"operationId": "ReadSegmentDhcpStaticBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs/binding1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"address1\",\n \"path\": \"/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/tier-1s/mgw/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595467058,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Create or update DHCP static binding",
"description": "If binding with the binding-id is not already present,\ncreate a new DHCP static binding instance. If it already exists, replace\nthe existing DHCP static binding instance with this object.\n",
"operationId": "CreateOrReplaceSegmentDhcpStaticBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\n{\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"gateway_address\": \"10.1.1.1\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"address1\",\n \"path\": \"/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/tier-1s/mgw/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595467058,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "DhcpStaticBindingConfig"
},
"delete": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Delete DHCP static binding",
"description": "Delete DHCP static binding",
"operationId": "DeleteSegmentDhcpStaticBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs/binding1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Create or update DHCP static binding",
"description": "If binding with the binding-id is not already present,\ncreate a new DHCP static binding instance. If it already exists, replace\nthe existing DHCP static binding instance with specified attributes.\n",
"operationId": "PatchSegmentDhcpStaticBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs/binding1\n{\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"gateway_address\": \"10.1.1.1\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n }\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "DhcpStaticBindingConfig"
}
},
"/global-infra/segments/{segment-id}/inter-site-forwarder/site-span-info": {
"get": {
"tags": [
"Federation",
"Inter-Sites"
],
"summary": "Get infra segment cross site forwarder placement and HA status",
"description": "Get infra segment cross site forwarder placement and HA statuss.\n",
"operationId": "GlobalInfraGetInfraSegmentCsSpanInfo",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentL2ForwarderSiteSpanInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/global-infra/segments/tier0-ls/inter-site-forwarder/site-span-info?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"segment_path\": \"/global-infra/segments/tier0-ls\",\n \"remote_macs_per_site\": [\n {\n \"rtep_group_id\": 2001,\n \"remote_site\": {\n \"target_id\": \"258c50b4-c960-4005-9023-f7946e302162\",\n \"target_display_name\": \"India Site\",\n \"is_valid\": true\n },\n \"remote_mac_addresses\": [ \"02:00:17:00:12:D3\", \"02:00:17:00:13:13\" ],\n \"remote_active_ips\": [ \"10.10.10.1\" ],\n \"remote_standby_ips\": [ \"20.20.20.1\" ]\n }\n ],\n \"last_update_timestamp\": 1457117071089\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/dns-forwarder/status": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-0 Gateways"
],
"summary": "Get current status of tier-0 DNS forwarder",
"description": "Get current status of tier-0 DNS forwarder.\n- no enforcement point path specified: Status will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Status will be evaluated only on the given enforcement\npoint.\n",
"operationId": "GlobalInfraGetTier0DNSForwarderStatus",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateDNSForwarderStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/tier-01/dns-forwarder/status\n",
"x-vmw-nsx-module": "PolicyDNSStatistics",
"x-vmw-nsx-example-response": "{\n \"status_per_enforcement_point\": [\n {\n \"resource_type\": \"NsxTDNSForwarderStatus\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"timestamp\": 1537263302625,\n \"status\": \"UP\"\n },\n {\n \"resource_type\": \"NsxTDNSForwarderStatus\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default1\",\n \"extra_message\": \"ERROR status could be an intermediate state during failover between transport nodes. Please recheck the status a few minutes later.\",\n \"timestamp\": 1537263302625,\n \"status\": \"ERROR\"\n }\n ],\n \"intent_path\": \"/infra/tier-0s/tier-01/dns-forwarder\"\n}\n"
}
},
"/infra/qos-profiles/{qos-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Details of QoS profile\n",
"description": "API will return details of QoS profile.\n",
"operationId": "ReadQoSProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_2\n",
"x-vmw-nsx-module": "PolicyQoS",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"QoSProfile\",\n \"id\": \"profile_2\",\n \"display_name\": \"/infra/qos-profiles/profile_2\",\n \"path\": \"/infra/qos-profiles/profile_2\",\n \"parent_path\": \"/infra/domains/d1/groups/group_vm\",\n \"relative_path\": \"profile_2\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Create or Replace QoS profile.",
"description": "Create or Replace QoS profile.\n",
"operationId": "CreateOrReplaceQoSProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_2\n{\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2\n}\n",
"x-vmw-nsx-module": "PolicyQoS",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"QoSProfile\",\n \"id\": \"profile_2\",\n \"display_name\": \"profile_2\",\n \"path\": \"/infra/qos-profiles/profile_2\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile_2\",\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "QoSProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Delete QoS profile",
"description": "API will delete QoS profile.\n",
"operationId": "DeleteQoSProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_1\n",
"x-vmw-nsx-module": "PolicyQoS"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profiles"
],
"summary": "Patch QoS profile.",
"description": "Create a new QoS profile if the QoS profile with\ngiven id does not already exist. If the QoS profile with the\ngiven id already exists, patch with the existing QoS profile.\n",
"operationId": "PatchQoSProfile",
"parameters": [
{
"name": "qos-profile-id",
"in": "path",
"description": "QoS profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QoSProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/qos-profiles/profile_1\n{\n \"dscp\":\n {\n \"mode\": \"TRUSTED\",\n \"priority\": 0\n },\n \"shaper_configurations\": [\n {\n \"resource_type\": \"IngressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n },\n {\n \"resource_type\": \"IngressBroadcastRateLimiter\",\n \"enabled\": false,\n \"burst_size\": 0,\n \"peak_bandwidth\": 0,\n \"average_bandwidth\": 0\n },\n {\n \"resource_type\": \"EgressRateLimiter\",\n \"enabled\": false,\n \"average_bandwidth\": 0,\n \"peak_bandwidth\": 0,\n \"burst_size\": 0\n }\n ],\n \"class_of_service\": 2\n}\n",
"x-vmw-nsx-module": "PolicyQoS",
"x-codegen-request-body-name": "QoSProfile"
}
},
"/infra/traceflows": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "List TraceflowConfig for infra",
"description": "Paginated list of all TraceflowConfig for infra.\n",
"operationId": "ListTraceflowConfig",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/traceflows\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"segment_port_path\": \"/infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:c8d7ac3f-1904-4088-a9ec-f0183b5b14d6\",\n \"packet\": {\n \"eth_header\": {\n \"src_mac\": \"00:50:56:8f:49:60\",\n \"dst_mac\": \"00:50:56:8f:2f:97\",\n \"eth_type\": 2048\n },\n \"ip_header\": {\n \"src_ip\": \"172.16.14.11\",\n \"dst_ip\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transport_header\": {\n \"icmp_echo_request_header\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"payload\": \"\",\n \"resource_type\": \"FieldsPacketData\",\n \"frame_size\": 128,\n \"routed\": true,\n \"transport_type\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"TraceflowConfig\",\n \"id\": \"t7\",\n \"display_name\": \"t7\",\n \"path\": \"/infra/traceflows/t7\",\n \"relative_path\": \"t7\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"4dbe1a62-156c-46be-a70f-ea237344f1c3\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579195094519,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579195094519,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/segments/{segment-id}/mac-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"MAC Table"
],
"summary": "Get infra segment MAC table in CSV",
"description": "Returns MAC table for a segment\n",
"operationId": "GetInfraSegmentMacTableInCsv",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/MacAddressCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWN_LINK_SWITCH/mac-table?format=csv&source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,mac_type\n00:0c:29:ce:0f:77,STATIC\n"
}
},
"/infra/sites/agents/metrics": {
"get": {
"summary": "Fetch current Metric agent config",
"description": "Fetch current Metric agent config",
"operationId": "GetMetricsAgent",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsAgent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy>/policy/api/v1/infra/sites/agents/metrics\n",
"x-vmw-nsx-module": "MetricsAgent",
"x-vmw-nsx-example-response": "{\n \"correlation_id\": \"545ec14f-56f8-4585-bbf4-6bd859bf9463\",\n \"receiver_endpoint\": \"nsx-metrics.vdp.vmware.com\",\n \"org_id\": \"org1\",\n \"instance_id\": \"abcec14f-56f8-4585-bbf4-6bd859bf9def\",\n \"admin_action\": \"ONBOARD\",\n \"log_level\": \"INFO\",\n \"enable_time_series_metrics_ingestion\" : false,\n \"_revision\": 2\n}\n"
},
"put": {
"summary": "Create Metrics agent intent resource",
"description": "Create Metrics agent intent resource",
"operationId": "CreateOrUpdateMetricsAgent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsAgent"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsAgent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy>/policy/api/v1/infra/sites/agents/metrics\n{\n \"correlation_id\": \"545ec14f-56f8-4585-bbf4-6bd859bf9463\",\n \"receiver_endpoint\": \"nsx-metrics.vdp.vmware.com\",\n \"org_id\": \"org1\",\n \"instance_id\": \"abcec14f-56f8-4585-bbf4-6bd859bf9def\",\n \"admin_action\": \"ONBOARD\",\n}\n",
"x-vmw-nsx-module": "MetricsAgent",
"x-vmw-nsx-example-response": "{\n \"correlation_id\": \"545ec14f-56f8-4585-bbf4-6bd859bf9463\",\n \"receiver_endpoint\": \"nsx-metrics.vdp.vmware.com\",\n \"org_id\": \"org1\",\n \"instance_id\": \"abcec14f-56f8-4585-bbf4-6bd859bf9def\",\n \"admin_action\": \"ONBOARD\",\n \"log_level\": \"INFO\",\n \"enable_time_series_metrics_ingestion\" : false,\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "MetricsAgent"
}
},
"/global-infra/tags": {
"get": {
"tags": [
"Policy",
"Inventory",
"Tags"
],
"summary": "List all unique tags.",
"description": "Returns paginated list of all unique tags. Supports filtering by scope, tag and\nsource from which tags are synced. Supports starts with, ends with, equals and\ncontains operators on scope and tag values.\nTo filter tags by starts with on scope or tag, use '*' as suffix after the value.\nTo filter tags by ends with on scope or tag, use '*' as prefix before the value.\nTo filter tags by contain on scope or tag, use '*' as prefix and suffix on the value.\nBelow special characters in the filter value needs to be escaped with hex values.\n- Character '&' needs to be escaped as '%26'\n- Character '[' needs to be escaped as '%5B'\n- Character ']' needs to be escaped as '%5D'\n- Character '+' needs to be escaped as '%2B'\n- Character '#' needs to be escaped as '%23'\nSort option for list of unique tags is available only on tag and scope properties.\n",
"operationId": "GlobalInfraListAllTags",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "scope",
"in": "query",
"description": "Tag scope",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Source from which tags are synced.",
"schema": {
"type": "string",
"enum": [
"Amazon",
"Azure",
"NSX",
"ANY"
]
}
},
{
"name": "tag",
"in": "query",
"description": "Tag value",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagInfoListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tags\n",
"x-vmw-nsx-module": "PolicyTag",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"scope\": \"os\",\n \"tag\": \"windows\",\n \"tagged_objects\": 250\n },\n {\n \"scope\": \"os\",\n \"tag\": \"ubantu\",\n \"tagged_objects\": 100\n }\n ],\n \"result_count\": 2\n}\n{\n \"results\": [\n {\n \"scope\": \"os\",\n \"tag\": \"windows\",\n \"tagged_objects\": 250\n }\n ],\n \"result_count\": 1\n}\n{\n \"results\": [\n {\n \"scope\": \"os\",\n \"tag\": \"ubantu\",\n \"tagged_objects\": 100\n }\n ],\n \"result_count\": 1\n}\n"
}
},
"/global-infra/segments/{segments-id}/ports/{port-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"Status"
],
"summary": "Get infra segment port status information",
"description": "Get infra segment port status information.\n",
"operationId": "GlobalInfraGetInfraSegmentPortStatus",
"parameters": [
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/tier0-ls-2/ports/ls2-p1/status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_port_id\": \"04efc498-b872-40fc-83f8-ebf9317a2766\",\n \"last_update_timestamp\": 1453764613211,\n \"status\": \"UP\"\n}\n"
}
},
"/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Get IPSec tunnel Profile",
"description": "Get custom IPSec tunnel Profile, given the particular id.",
"operationId": "GetIPSecVpnTunnelProfile",
"parameters": [
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"path\": \"/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\",\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Create or fully replace a custom IPSec tunnel Profile",
"description": "Create or fully replace custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.",
"operationId": "CreateOrUpdateIPSecVpnTunnelProfile",
"parameters": [
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\n{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\"\n \"_revision\" : 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"path\": \"/infra/ipsec-vpn-ike-profiles/aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\",\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnTunnelProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Delete custom IPSec tunnel Profile",
"description": "Delete custom IPSec tunnel Profile. Profile can not be deleted if profile has references to it.",
"operationId": "DeleteIPSecVpnTunnelProfile",
"parameters": [
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IPSEC Profiles"
],
"summary": "Create or patch a custom IPSec tunnel Profile",
"description": "Create or patch custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile.",
"operationId": "CreateOrPatchIPSecVpnTunnelProfile",
"parameters": [
{
"name": "tunnel-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnTunnelProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-tunnel-profiles/aws-tunnel-profile\n{\n \"resource_type\" : \"IPSecVpnTunnelProfile\",\n \"display_name\" : \"aws-tunnel-profile\",\n \"enable_perfect_forward_secrecy\" : true,\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 3600,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"df_policy\" : \"COPY\"\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnTunnelProfile"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Statistics"
],
"summary": "Get gateway policy statistics",
"description": "Get statistics of a gateay policy.\n- no enforcement point path specified: Stats will be evaluated on each enforcement.\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGatewayPolicyStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicyStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/gateway-policies/emergency/statistics?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n {\n \"rule\": \"ce-1\",\n \"internal_rule_id\": \"1001\",\n \"packet_count\": 3806,\n \"session_count\": 819,\n \"hit_count\": 45,\n \"byte_count\": 322989,\n \"popularity_index\": 85,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n },\n {\n \"rule\": \"ce-2\",\n \"internal_rule_id\": \"1002\",\n \"packet_count\": 8762,\n \"session_count\": 62,\n \"hit_count\": 45,\n \"byte_count\": 76201,\n \"popularity_index\": 13,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n }\n ],\n \"cursor\" : 1,\n \"result_count\" : 2\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Get IPSec VPN service",
"description": "Get IPSec VPN service under Tier-0.\n",
"operationId": "GetTier0VpnIPSecVpnService",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnService\",\n \"path\" : \"/infra/tier-0s/ext_net/ipsec-vpn-services/default\",\n \"ike_log_level\" : \"ERROR\",\n \"enabled\" : false,\n \"bypass_rules\" : [],\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Create or fully replace IPSec VPN service",
"description": "Create or fully replace IPSec VPN service under given Tier-0.\nRevision is optional for creation and required for update.\n",
"operationId": "CreateOrUpdateTier0VpnIPSecVpnService",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default\n{\n \"resource_type\" : \"IPSecVpnService\",\n \"ike_log_level\" : \"ERROR\",\n \"enabled\" : true,\n \"_revision\" : 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnService\",\n \"path\" : \"/infra/tier-0s/ext_net/ipsec-vpn-services/default\",\n \"ike_log_level\" : \"ERROR\",\n \"enabled\" : false,\n \"bypass_rules\" : [],\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnService"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Delete IPSec VPN service",
"description": "Delete IPSec VPN service for under Tier-0.\n",
"operationId": "DeleteTier0VpnIPSecVpnService",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Create or patch IPSec VPN service",
"description": "Create or patch IPSec VPN service under Tier-0.\n",
"operationId": "CreateOrPatchTier0VpnIPSecVpnService",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default\n{\n \"resource_type\": \"IPSecVpnService\",\n \"ike_log_level\": \"ERROR\",\n \"enabled\": true\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnService"
}
},
"/infra/domains/{domain-id}/endpoint-policies/{endpoint-policy-id}/endpoint-rules": {
"get": {
"tags": [
"Policy",
"Security",
"Endpoint Protection",
"Rules"
],
"summary": "List Endpoint rules",
"description": "List Endpoint rules",
"operationId": "ListEndpointRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "endpoint-policy-id",
"in": "path",
"description": "Endpoint policy id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointRuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/gi_domain/endpoint-policies/map1/endpoint-rules\n",
"x-vmw-nsx-module": "PolicyGuestIntrospection",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"sequence_number\": 10,\n \"groups\": [\n \"/infra/domains/gi_domain/groups/test_group\"\n ],\n \"service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_1\"\n ],\n \"resource_type\": \"EndpointRule\",\n \"id\": \"gi-entry-1\",\n \"display_name\": \"gi-entry-1\",\n \"path\": \"/infra/domains/gi_domain/endpoint-policies/map1/endpoint-rules/gi-entry-1\",\n \"relative_path\": \"gi-entry-1\",\n \"parent_path\": \"/infra/domains/gi_domain/endpoint-policies/map1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1542326971854,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1542829025115,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n },\n {\n \"sequence_number\": 11,\n \"groups\": [\n \"/infra/domains/gi_domain/groups/test_group\"\n ],\n \"service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_2\"\n ],\n \"resource_type\": \"EndpointRule\",\n \"id\": \"gi-entry-2\",\n \"display_name\": \"gi-entry-2\",\n \"path\": \"/infra/domains/gi_domain/endpoint-policies/map1/endpoint-rules/gi-entry-2\",\n \"relative_path\": \"gi-entry-2\",\n \"parent_path\": \"/infra/domains/gi_domain/endpoint-policies/map1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1542829270619,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1542829270621,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ],\n \"result_count\": 2,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "Read service interface",
"description": "Read service interface",
"operationId": "GlobalInfraReadServiceInterface",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInterface"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/service-interfaces/to_internet\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ServiceInterface\",\n \"id\": \"to_internet\",\n \"display_name\": \"to_internet\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/default/service-interfaces/to_internet\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv/locale-services/default\",\n \"relative_path\": \"to_internet\",\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/deployment-zones/{deployment-zone-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Deployment Zones"
],
"summary": "Read a DeploymentZone",
"description": "Read a Deployment Zone.\n\n
\nThis is a deprecated API. DeploymentZone has been renamed to Site.\nUse GET /infra/sites/site-id.\n",
"operationId": "ReadDeploymentZoneInfra",
"parameters": [
{
"name": "deployment-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentZone"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyEnforcementPointManagement"
}
},
"/global-infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Prefix List"
],
"summary": "Read a prefix list",
"description": "Read a prefix list",
"operationId": "GlobalInfraReadPrefixList",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "prefix-list-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrefixList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/prefix-lists/to-onprem\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PrefixList\",\n \"id\": \"to-onprem\",\n \"display_name\": \"/infra/tier-0s/vmc/prefix-lists/to-onprem\",\n \"path\": \"/infra/tier-0s/vmc/prefix-lists/to-onprem\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"to-onprem\",\n \"marked_for_delete\": false,\n \"prefixes\": [\n {\n \"action\": \"PERMIT\",\n \"network\": \"30.1.1.0/24\"\n },\n {\n \"action\": \"DENY\",\n \"network\": \"10.1.1.0/24\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1525754971782,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1525755003657,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes BFD Peers"
],
"summary": "List StaticRouteBfdPeers",
"description": "Paginated list of all StaticRouteBfdPeers.\n",
"operationId": "GlobalInfraListStaticRouteBfdPeer",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRouteBfdPeerListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/t0/static-routes/bfd-peers\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"enabled\": true,\n \"peer_address\": \"10.1.1.1\",\n \"bfd_profile_path\": \"/infra/bfd-profiles/config2\",\n \"resource_type\": \"StaticRouteBfdPeer\",\n \"id\": \"peer1\",\n \"display_name\": \"peer1\",\n \"path\": \"/infra/tier-0s/pepsi/static-routes/bfd-peers/peer1\",\n \"relative_path\": \"peer1\",\n \"parent_path\": \"/infra/tier-0s/pepsi\",\n \"unique_id\": \"a917f621-1822-4dc2-b029-ba1c917f8f4b\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579289913498,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579289913498,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/crls": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certification Revocation List"
],
"summary": "Return All Added CRLs",
"description": "Returns information about all CRLs. For additional information, include the\n?details=true modifier at the end of the request URI.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTlsCrls",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "whether to expand the pem data and show all its details",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "node_id",
"in": "query",
"description": "Node ID of certificate to return",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type of certificate to return",
"schema": {
"type": "string",
"enum": [
"cluster_api_certificate",
"api_certificate"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCrlListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/crls?details=true\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"TlsCrl\",\n \"display_name\": \"revoked certificates\",\n \"path\": \"/infra/crls/revokedCerts\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"revokedCerts\",\n \"pem_encoded\": \"-----BEGIN X509 CRL----------END X509 CRL-----\\n\",\n \"details\": {\n \"next_update\": \"945220365000\",\n \"issuer\": \"1.2.840.113549.1.9.1=#161d726f6f744069676c6f6f2e6974732e756e696d656c622e6564752e6175,CN=igloo Certificate Authority,OU=Certificates Administration,O=igloo CA,L=Melbourne,ST=Victoria,C=AU\",\n \"version\": \"1\"\n },\n \"crl_type\": \"X509\",\n \"unique_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"realization_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1413387436438,\n \"_create_time\": 1413386249116,\n \"_create_user\": \"admin\"\n },\n {\n \"crl_type\": \"OneCRL\",\n \"one_crl\": \"{\\\"data\\\":[ <...> ]}\",\n \"details_revoked_by_issuer_and_serial_number\": [ <...> ],\n \"details_revoked_by_subject_and_public_key_hash\": [ <...> ],\n \"resource_type\": \"TlsCrl\",\n \"id\": \"default_public_crl\",\n \"display_name\": \"default_public_crl\",\n \"path\": \"/infra/crls/default_public_crl\",\n \"relative_path\": \"default_public_crl\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"91503436-5215-4d13-93e0-094c7473e30d\",\n \"realization_id\": \"91503436-5215-4d13-93e0-094c7473e30d\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1630097138768,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1630107914252,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n ]\n}\n"
}
},
"/infra/realized-state/enforcement-points/{enforcement-point-name}/groups/nsgroups/{nsgroup-name}": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "Read Group",
"description": "Read a NSGroup and the complete tree underneath. Returns the\npopulated NSgroup object.\n",
"operationId": "ReadNSGroupRealizedState",
"parameters": [
{
"name": "enforcement-point-name",
"in": "path",
"description": "Enforcement Point Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nsgroup-name",
"in": "path",
"description": "Group Name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericPolicyRealizedResource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyRealizedState"
}
},
"/global-infra/segments/{segment-id}/gateway-interface-arp-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table for downlink router port on tier-0 router",
"description": "Get ARP table for downlink router port on tier-0 router.\n
\nThis API is deprecated because it is duplicate.\nPlease use /infra/segments/<segment-id>/arp-table\nSegment ID is the ID of the segment that is connected to the the tier-0\n",
"operationId": "GlobalInfraGetDownlinkPortArpTableForInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWNLINK_SWITCH/gateway-interface-arp-table?edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/7f7d37a7-b78e-4378-949d-09190cbfef7d/edge-nodes/a831390e-a7c8-11ea-9102-020063e79023\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"interface_path\": \"/infra/realized-state/enforcement-points/default/logical-ports/TLR0_LR-TIER0_DOWNLINK_SWITCH-dlrp\",\n \"last_update_timestamp\": 1591854345080,\n \"results\": [\n {\n \"mac_address\": \"00:0c:29:ad:24:e4\",\n \"ip\": \"192.168.100.163\"\n },\n {\n \"mac_address\": \"00:00:00:00:00:00\",\n \"ip\": \"192.168.100.161\"\n },\n {\n \"mac_address\": \"00:00:00:00:00:00\",\n \"ip\": \"192.168.100.160\"\n }\n ],\n \"result_count\": 3,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/aaa/roles": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Get information about all roles",
"description": "Get information about all roles",
"operationId": "GetAllRolesInfo",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "scope",
"in": "query",
"description": "List only the roles which are applicable for this scope.",
"schema": {
"type": "string",
"enum": [
"ROOT",
"ORG",
"PROJECT",
"VPC"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/aaa/roles\n",
"x-vmw-nsx-module": "AAA",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"role\": \"enterprise_admin\"\n },\n {\n \"role\": \"security_op\"\n },\n {\n \"role\": \"auditor\"\n },\n {\n \"role\": \"security_engineer\"\n },\n {\n \"role\": \"network_op\"\n },\n {\n \"role\": \"network_engineer\"\n }\n ]\n}\n"
}
},
"/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "List Infra Port Discovery Profile Binding Maps",
"description": "API will list all Infra Port Discovery Profile Binding Maps in current port id.\n",
"operationId": "GlobalInfraListInfraPortDiscoveryBindings",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies"
],
"summary": "Read rule",
"description": "Read rule",
"operationId": "GlobalInfraReadForwardingRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "forwarding-policy-id",
"in": "path",
"description": "Forwarding map id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1/rules/rule-1\n",
"x-vmw-nsx-module": "PolicyForwarding",
"x-vmw-nsx-example-response": "{\n\"resource_type\": \"ForwardingRule\",\n\"description\": \"s3 rule\",\n\"id\": \"rule-1\",\n\"display_name\": \"rule-1\",\n\"action\":\"FORWARD_TO_UNDERLAY\",\n\"tags\": [],\n\"path\": \"/infra/domains/domain1/forwarding-policies/forwarding-policy-1000/rules/forwarding-rule-1\",\n\"relative_path\": \"rule-1\",\n\"sequence_number\": 0,\n\"source_groups\": [\n \"/infra/domains/domain1/groups/srcgrp\"\n],\n\"services\": [\n \"ANY\"\n ],\n\"logged\": false,\n\"destination_groups\": [\n \"/infra/domains/default/groups/S3\"\n],\n\"_create_user\": \"admin\",\n\"_create_time\": 1509362026134,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1509362026135,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/groups/{group-id}": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Gateway Firewall Groups"
],
"summary": "Read Tier-0 Group",
"description": "Read Tier-0 Group",
"operationId": "GlobalInfraReadTier0Group",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/groups/source\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Group\",\n \"description\": \"source\",\n \"id\": \"source\",\n \"display_name\": \"source\",\n \"path\": \"/infra/tier-0s/vmc/groups/source\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"source\",\n \"expression\": [\n {\n \"resource_type\": \"IPAddressExpression\",\n \"ip_addresses\": [\n \"10.10.10.10/31\"\n ],\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386332506,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516430525682,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
}
},
"/infra/settings/firewall/idfw/vm-stats/{vm-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Get IDFW user login events for a given VM",
"description": "It will get IDFW user login events for a given VM\n(all active plus up to 5 most recent archived entries).\n",
"operationId": "GetUserLoginEventsForAVM",
"parameters": [
{
"name": "vm-id",
"in": "path",
"description": "VM id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdfwVmStats"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-ip>/policy/api/v1/infra/settings/firewall/idfw/vm-stats/<vm-id>\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"active_sessions\": [\n {\n \"id\": \"9540cd6d-8d46-4c20-b2cc-491efc005865\",\n \"domain_name\": \"IDFW0\",\n \"user_name\": \"administrator\",\n \"user_id\": \"10446e86-99c1-43a7-8345-fda90c56291c\",\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"user_session_id\": 2,\n \"login_time\": 1589165250502,\n \"logout_time\": 0\n }\n ],\n \"archived_sessions\": [\n {\n \"id\": \"198de711-e83e-4ff9-be85-6e024f9dc1a7\",\n \"domain_name\": \"DESKTOP-2GEFUOB\",\n \"user_name\": \"Administrator\",\n \"user_id\": \"\",\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"user_session_id\": 1,\n \"login_time\": 1588744262515,\n \"logout_time\": 1588750666046\n },\n {\n \"id\": \"96efd394-b4a3-4d18-9f1a-307dfe34bc62\",\n \"domain_name\": \"KCWIN101\",\n \"user_name\": \"Administrator\",\n \"user_id\": \"\",\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"user_session_id\": 1,\n \"login_time\": 1588750750783,\n \"logout_time\": 1588754687486\n },\n {\n \"id\": \"9e8ae910-8846-4b63-ac4a-6572ac43a6c1\",\n \"domain_name\": \"IDFW0\",\n \"user_name\": \"administrator\",\n \"user_id\": \"10446e86-99c1-43a7-8345-fda90c56291c\",\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"user_session_id\": 2,\n \"login_time\": 1588759570683,\n \"logout_time\": 1588788406470\n },\n {\n \"id\": \"288f8533-7b40-47e7-9435-4d0ea80dee32\",\n \"domain_name\": \"KCWIN101\",\n \"user_name\": \"Administrator\",\n \"user_id\": \"\",\n \"vm_ext_id\": \"501ae853-9b09-69e3-394a-1af06f7dbfec\",\n \"user_session_id\": 1,\n \"login_time\": 1588935137151,\n \"logout_time\": 1588964081327\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-clusters/{edge-cluster-id}/url-categorization-configs/{url-categorization-config-id}": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Url Categorization"
],
"summary": "Get PolicyUrlCategorizationConfig",
"description": "Gets a PolicyUrlCategorizationConfig. This returns the details of the\nconfig like whether the URL categorization is activated or deactivated, the id\nof the context profiles which are used to filter the categories, and the\nupdate frequency of the data from the cloud.\n",
"operationId": "GetPolicyUrlCategorizationConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "edge-cluster-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url-categorization-config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyUrlCategorizationConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/api/v1/infra/sites/default/enforcement-points/enforcement-point-id/edge-clusters/edge-cluster-id/edge-node-id/url-categorization-configs/default\n",
"x-vmw-nsx-module": "PolicyUrlCategorization",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyUrlCategorizationConfig\",\n \"path\" : \"/infra/sites/default/enforcement-points/enforcement-point-id/edge-clusters/edge-cluster-id/edge-node-id/url-categorization-configs/default\",\n \"id\" : \"default\",\n \"enabled\" : true,\n \"context_profiles\"; [\n \"/infra/context-profiles/policy-context-profile-1\",\n \"/infra/context-profiles/policy-context-profile-2\"\n ],\n \"update_frequency\": 5\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Url Categorization"
],
"summary": "Create or Update PolicyUrlCategorizationConfig",
"description": "Creates/Updates a PolicyUrlCategorizationConfig. Creating or updating the\nPolicyUrlCategorizationConfig will activate or deactivate URL categorization for\nthe given edge cluster. If the context_profiles field is empty, the edge\ncluster will detect all the categories of URLs. If context_profiles field\nhas any context profiles, the edge cluster will detect only the categories\nlisted within those context profiles. The context profiles should have\nattribute type URL_CATEGORY. The update_frequency specifies how frequently\nin minutes, the edge cluster will get updates about the URL data from the\nURL categorization cloud service. If the update_frequency is not specified,\nthe default update frequency will be 30 min.\n",
"operationId": "PutPolicyUrlCategorizationConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "edge-cluster-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url-categorization-config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyUrlCategorizationConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyUrlCategorizationConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/api/v1/infra/sites/default/enforcement-points/enforcement-point-id/edge-clusters/edge-cluster-id/url-categorization-configs/default\n{\n \"enabled\" : true,\n \"context_profiles\"; [\n \"/infra/context-profiles/policy-context-profile-1\",\n \"/infra/context-profiles/policy-context-profile-2\"\n ]\n}\n",
"x-vmw-nsx-module": "PolicyUrlCategorization",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyUrlCategorizationConfig\",\n \"path\" : \"/infra/sites/default/enforcement-points/enforcement-point-id/edge-clusters/edge-cluster-id/url-categorization-configs/default\",\n \"id\" : \"default\",\n \"enabled\" : true,\n \"context_profiles\"; [\n \"/infra/context-profiles/policy-context-profile-1\",\n \"/infra/context-profiles/policy-context-profile-2\"\n ],\n \"update_frequency\": 30\n}\n",
"x-codegen-request-body-name": "PolicyUrlCategorizationConfig"
},
"delete": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Url Categorization"
],
"summary": "Delete PolicyUrlCategorizationConfig",
"description": "Delete PolicyUrlCategorizationConfig. If deleted, the URL categorization\nwill be deactivated for that edge cluster.\n",
"operationId": "DeletePolicyUrlCategorizationConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "edge-cluster-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url-categorization-config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/api/v1/infra/sites/default/enforcement-points/enforcement-point-id/edge-clusters/edge-cluster-id/edge-node-id/url-categorization-configs/default\n",
"x-vmw-nsx-module": "PolicyUrlCategorization"
},
"patch": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Url Categorization"
],
"summary": "Create or Update PolicyUrlCategorizationConfig",
"description": "Creates/Updates a PolicyUrlCategorizationConfig. Creating or updating the\nPolicyUrlCategorizationConfig will activate or deactivate URL categorization for\nthe given edge cluster. If the context_profiles field is empty, the edge\ncluster will detect all the categories of URLs. If context_profiles field\nhas any context profiles, the edge cluster will detect only the categories\nlisted within those context profiles. The context profiles should have\nattribute type URL_CATEGORY. The update_frequency specifies how frequently\nin minutes, the edge cluster will get updates about the URL data from the\nURL categorization cloud service. If the update_frequency is not specified,\nthe default update frequency will be 30 min.\n",
"operationId": "PatchPolicyUrlCategorizationConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "edge-cluster-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url-categorization-config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyUrlCategorizationConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyUrlCategorizationConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/api/v1/infra/sites/default/enforcement-points/enforcement-point-id/edge-clusters/edge-cluster-id/edge-node-id/url-categorization-configs/default\n{\n \"enabled\" : true,\n \"context_profiles\"; [\n \"/infra/context-profiles/policy-context-profile-1\",\n \"/infra/context-profiles/policy-context-profile-2\"\n ],\n \"update_frequency\": 10\n}\n",
"x-vmw-nsx-module": "PolicyUrlCategorization",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyUrlCategorizationConfig\",\n \"path\" : \"/infra/sites/default/enforcement-points/enforcement-point-id/edge-clusters/edge-cluster-id/edge-node-id/url-categorization-configs/default\",\n \"id\" : \"default\",\n \"enabled\" : true,\n \"context_profiles\"; [\n \"/infra/context-profiles/policy-context-profile-1\",\n \"/infra/context-profiles/policy-context-profile-2\"\n ],\n \"update_frequency\": 10\n}\n",
"x-codegen-request-body-name": "PolicyUrlCategorizationConfig"
}
},
"/infra/sites/{site-id}/napp/deployment/upgrade-coordinator/checks/status": {
"get": {
"tags": [
"NSX Application Platform",
"Deployment",
"Upgrade",
"Coordinator",
"Check",
"Status"
],
"summary": "Get NSX Application Platform upgrade-coordinator pre/post checks progress status.",
"description": "Get NSX Application Platform upgrade-coordinator pre/post checks progress status.",
"operationId": "GetUCDeploymentChecksStatus",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentChecksStatusResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/napp/deployment/upgrade-coordinator/checks/status\n",
"x-vmw-nsx-module": "PolicyCloudNativeUpgradeCoordinator",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"DeploymentChecksStatusResult\",\n \"result\" : [\n {\"name\": \"check1\", \"desc\": \"...\", \"status\": \"SUCCESS\", \"reason\": \"\"}\n {\"name\": \"check2\", \"desc\": \"...\", \"status\": \"FAILED\", \"reason\": \"Reason for failure\"}\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/intrusion-service-policies/{ids-policy-id}/rules/{rule-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules",
"Statistics"
],
"summary": "Get IDS-IPS rule statistics",
"description": "Get statistics of a IDS-IPS rule.\n- no enforcement point path specified: Stats will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "GetIdsRuleStatistics",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ids-policy-id",
"in": "path",
"description": "IDS policy id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRuleStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/intrusion-service-policies/pol-6/rules/Test-Rule21/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyIDSStats",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"enforcement_point\": \"/infra/sites/default/enforcement-points/default\",\n \"statistics\": {\n \"rule\": \"/infra/domains/default/intrusion-service-policies/pol-6/rules/Test-Rule21\",\n \"internal_rule_id\": \"3049\",\n \"packet_count\": 0,\n \"byte_count\": 0,\n \"session_count\": 0,\n \"hit_count\": 0\n }\n }\n ],\n \"result_count\": 1\n }\n"
}
},
"/infra/settings/firewall/security/intrusion-services/affected-vms": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Dashboard"
],
"summary": "Get the list of the VMs affected for that signature",
"description": "Get the list of the VMs affected pertaining to a specific\nsignature.\n",
"operationId": "GetPolicyAffectedVms",
"parameters": [
{
"name": "context",
"in": "query",
"description": "Tenancy Context of the API request",
"schema": {
"type": "string",
"enum": [
"ALL_PROJECTS"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsEventDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsVmList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/affected-vms\n {\n \"filters\": [\n {\n \"field_names\":\"intrusion_timestamp\",\"value\":\" >1590533447645\"\n },\n {\n \"field_names\": \"signature_detail.signature_id\",\n \"value\": \"(4010643)\"\n }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyIDSMetrics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n \"1-vm_ubuntu-18.04-server-amd64-local-1702-38876fd9-5748-4cdc-93f7-3c45791622b7\",\n \"1-linuxrouter_ubuntu-16.04-server-amd64-container-local-1702-d3fadb32-c51e-437a-86f1-ff717c6d736f\"\n ],\n \"result_count\": 2,\n \"sort_by\": \"displayName\",\n \"sort_ascending\": false,\n \"cursor\": \"2\"\n}\n",
"x-codegen-request-body-name": "PolicyIdsEventDataRequest"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "List Tier-1 segment ports",
"description": "List all the ports for a Tier-1 segment.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1SegmentPorts",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/production_t1/segments/production-t1-seg/ports/\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"resource_type\": \"SegmentPort\",\n \"id\": \"default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"display_name\": \"default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"path\": \"/infra/tier-1s/production_t1/segments/production-t1-seg/ports/default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"relative_path\": \"default:183a3789-826b-41fc-8642-a6834551d4bc\",\n \"parent_path\": \"/infra/tier-1s/production_t1/segments/production-t1-seg\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1544503100539,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1544503100539,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"SegmentPort\",\n \"id\": \"default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"display_name\": \"default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"path\": \"/infra/tier-1s/production_t1/segments/production-t1-seg/ports/default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"relative_path\": \"default:7555e0d8-f8f7-47c1-a93c-436eb5a6628a\",\n \"parent_path\": \"/infra/tier-1s/production_t1/segments/production-t1-seg\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1544503100542,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1544503100542,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"SegmentPort\",\n \"id\": \"default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"display_name\": \"default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"path\": \"/infra/tier-1s/production_t1/segments/production-t1-seg/ports/default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"relative_path\": \"default:ab5e6c6d-ca35-499d-b448-fbb82ed1664b\",\n \"parent_path\": \"/infra/tier-1s/production_t1/segments/production-t1-seg\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1544503100524,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1544503100524,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 3,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from tier-1 interface in CSV format",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format\nfor the tier-1 interface, on a edge node specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "GlobalInfraGetTier1InterfaceArpTableCsv",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/locale-services/default/interfaces/to_internet/arp-table?format=csv&enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,ip\n02:50:56:56:44:52,172.16.20.1\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Get IPSec VPN local endpoint",
"description": "Get IPSec VPN local endpoint for a given locale\nservice under Tier-1.\n\n
\nThis API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/\nlocal-endpoints/<local-endpoint-id> instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n",
"operationId": "GetTier1IPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/local-endpoints/default-le\n",
"x-vmw-nsx-module": "PolicyIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"path\" : \"/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Create or fully replace IPSec VPN local endpoint",
"description": "Create or fully replace IPSec VPN local endpoint\nfor a given locale service under Tier-1.\nRevision is optional for creation and required for update.\n\n
\nThis API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/\nlocal-endpoints/<local-endpoint-id> instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n Also VPN path returned in the Alarm, GPRR payload may include the new VPN path\n",
"operationId": "CreateOrUpdateTier1IPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/local-endpoints/default-le\n{\n \"resource_type\": \"IPSecVpnLocalEndpoint\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_revision\": 2\n}\n",
"x-vmw-nsx-module": "PolicyIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"path\" : \"/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnLocalEndpoint"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Delete IPSec VPN local endpoint",
"description": "Delete IPSec VPN local endpoint for a given locale\nservice under Tier-1.\n\n
\nThis API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/\nlocal-endpoints/<local-endpoint-id> instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n Also VPN path returned in the Alarm, GPRR payload may include the new VPN path\n",
"operationId": "DeleteTier1IPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/local-endpoints/default-le\n",
"x-vmw-nsx-module": "PolicyIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Create or patch a custom IPSec VPN local endpoint",
"description": "Create or patch a custom IPSec VPN local endpoint for a given locale service under Tier-1.\n\n
\nThis API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/\nlocal-endpoints/<local-endpoint-id> instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n Also VPN path returned in the Alarm, GPRR payload may include the new VPN path\n",
"operationId": "CreateOrPatchTier1IPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/local-endpoints/default-le\n{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\"\n}\n",
"x-vmw-nsx-module": "PolicyIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnLocalEndpoint"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/constraints": {
"get": {
"tags": [
"Policy",
"Infra",
"Constraints"
],
"summary": "List tenant Constraints.",
"description": "List tenant constraints.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTenantConstraints",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstraintListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>policy/api/v1/infra/constraints\n",
"x-vmw-nsx-module": "PolicyConstraints",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 3,\n \"results\": [\n {\n \"constraint_expression\": {\n \"resource_type\": \"RelatedAttributeConditionalExpression\",\n \"condition\": {\n \"value_constraint\": {\n \"resource_type\": \"ValueConstraintExpression\",\n \"values\": [\n \"/infra/services/HTTP\",\n \"/infra/services/HTTPS\"\n ],\n \"operator\": \"INCLUDES\",\n \"_protection\": \"NOT_PROTECTED\"\n },\n \"rhs_value\": [\n \"/infra/domains/mgw/groups/VCENTER\"\n ],\n \"operator\": \"INCLUDES\"\n },\n \"related_attribute\": {\n \"attribute\": \"destinationGroups\"\n },\n \"_protection\": \"NOT_PROTECTED\"\n },\n \"target\": {\n \"target_resource_type\": \"CommunicationEntry\",\n \"attribute\": \"services\",\n \"path_prefix\": \"/infra/domains/amar/edge-communication-maps/default/communication-entries/\"\n },\n \"_protection\": \"NOT_PROTECTED\"\n },\n {\n \"constraint_expression\": {\n \"resource_type\": \"ValueConstraintExpression\",\n \"values\": [\n \"ALLOW\"\n ],\n \"operator\": \"EQUALS\",\n \"_protection\": \"NOT_PROTECTED\"\n },\n \"target\": {\n \"target_resource_type\": \"CommunicationEntry\",\n \"attribute\": \"action\",\n \"path_prefix\": \"/infra/domains/amar/edge-communication-maps/default/communication-entries/\"\n },\n \"_protection\": \"NOT_PROTECTED\"\n },\n {\n \"constraint_expression\": {\n \"resource_type\": \"ValueConstraintExpression\",\n \"values\": [\n \"/infra/domains/amar/groups/VCENTER\"\n ],\n \"operator\": \"INCLUDES\",\n \"_protection\": \"NOT_PROTECTED\"\n },\n \"target\": {\n \"target_resource_type\": \"CommunicationEntry\",\n \"attribute\": \"destinationGroups\",\n \"path_prefix\": \"/infra/domains/amar/edge-communication-maps/default/communication-entries/\"\n },\n \"_protection\": \"NOT_PROTECTED\"\n },\n {\n \"constraint_expressions\": [{\n \"resource_type\": \"EntityCountConstraintExpression\",\n \"target_resource_type\": \"Group\",\n \"operator\": \"<\",\n \"count\" : 2\n },\n {\n \"resource_type\": \"EntityCountConstraintExpression\",\n \"target_resource_type\": \"Vpc\",\n \"operator\": \"<\",\n \"count\" : 2\n }]\n \"targets\": [{\n \"path_prefix\": \"/orgs/org1/projects/project1/\"\n },\n {\n \"path_prefix\": \"/orgs/org1/projects/project2/\"\n }]\n \"_protection\": \"NOT_PROTECTED\"\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/statistics/virtual-machines": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get effective VMs for the Group",
"description": "Get the effective VM membership for the Group. This API also gives some VM\ndetails such as VM name, IDs and the current state of the VMs.\n",
"operationId": "GetGroupVMStatistics",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealizedVirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/statistics/virtual-machines?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"RealizedVirtualMachine\",\n \"id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"1-vm_ubuntu_1404_srv_64-local-586-bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"path\": \"/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564de333-15ac-de52-da90-974fe099a17b\",\n \"parent_path\": \"/infra/realized-state/enforcement-points/nsx-1\",\n \"relative_path\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"intent_reference\": [],\n \"realization_specific_identifier\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"alarms\": [],\n \"state\": \"REALIZED\",\n \"runtime_status\": \"UNKNOWN\",\n \"compute_ids\": [\n \"moIdOnHost:1\",\n \"hostLocalId:1\",\n \"locationId:564de333-15ac-de52-da90-974fe099a17b\",\n \"instanceUuid:bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"externalId:564de333-15ac-de52-da90-974fe099a17b\",\n \"biosUuid:564de333-15ac-de52-da90-974fe099a17b\"\n ],\n \"power_state\": \"vm_running\",\n \"_create_user\": \"system\",\n \"_create_time\": 1519383616259,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1519383616259,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/segments/{segment-id}/dhcp-static-binding-configs": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings"
],
"summary": "List all DHCP static bindings",
"description": "Paginated list of all DHCP static binding instances\n",
"operationId": "GlobalInfraListInfraSegmentDhcpStaticBinding",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web1/dhcp-static-binding-configs\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"vm1-address\",\n \"path\": \"/infra/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595977854,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/sha/appliances/{appliance-id}/process/status": {
"get": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Appliance"
],
"summary": "Get the details of process status in given appliance.",
"description": "Get the details of process status in given appliance.",
"operationId": "GetProcessDataForAppliance",
"parameters": [
{
"name": "appliance-id",
"in": "path",
"description": "ID of appliance node",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplianceProcessData"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sha/appliances/f55ff9ec-3f91-11e7-8441-000c29ee2825/process/status\n",
"x-vmw-nsx-module": "PolicyShaAppliance",
"x-vmw-nsx-example-response": "{\n \"id\": \"72e1bd4b-6df6-42d0-9c59-a1c31312c9f1\",\n \"name\": \"manager-1\",\n \"top_process_by_mem_count\": 3,\n \"top_process_by_mem_list\": [\n {\n \"process_id\": \"3670\",\n \"user\": \"root\",\n \"priority\": \"10\",\n \"nice_value\": \"-10\",ß\n \"virtual_memory_size\": 5.107648,\n \"resident_memory_size\": 0.916868,\n \"cpu_usage\": 71.5,\n \"memory_usage\": 3.7,\n \"command\": \"java\",\n },\n {\n \"process_id\": \"5898\",\n \"user\": \"corfu\",\n \"priority\": \"10\",\n \"nice_value\": \"-10\",\n \"virtual_memory_size\": 7.027164,\n \"resident_memory_size\": 2.383,\n \"shared_memory_size\": 19.748,\n \"cpu_usage\": 42.7,\n \"memory_usage\": 10.1,\n \"command\": \"java\",\n\n },\n {\n \"process_id\": \"18355\",\n \"user\": \"root\",\n \"priority\": \"20\",\n \"nice_value\": \"0\",\n \"virtual_memory_size\": 8.388236,\n \"resident_memory_size\": 3.638,\n \"shared_memory_size\": 1.684,\n \"cpu_usage\": 31,\n \"memory_usage\": 15.5,\n \"command\": \"java\",\n\n }\n ],\n \"top_process_by_cpu_count\": 3,\n \"top_process_by_cpu_list\": [\n {\n \"process_id\": \"3670\",\n \"user\": \"root\",\n \"priority\": \"10\",\n \"nice_value\": \"-10\",\n \"virtual_memory_size\": 5.107648,\n \"resident_memory_size\": 0.916868,\n \"shared_memory_size\": 0.033636,\n \"cpu_usage\": 71.5,\n \"memory_usage\": 3.7,\n \"command\": \"java\",\n },\n {\n \"process_id\": \"5898\",\n \"user\": \"corfu\",\n \"priority\": \"10\",\n \"nice_value\": \"-10\",\n \"virtual_memory_size\": 7.027164,\n \"resident_memory_size\": 2.383,\n \"shared_memory_size\": 0.019748,\n \"cpu_usage\": 42.7\",\n \"memory_usage\": 10.1,\n \"command\": \"java\",\n\n },\n {\n \"process_id\": \"18355\",\n \"user\": \"root\",\n \"priority\": \"20\",\n \"nice_value\": \"0\",\n \"virtual_memory_size\": 8.388236,\n \"resident_memory_size\": 3.638,\n \"shared_memory_size\": 1.684,\n \"cpu_usage\": 31,\n \"memory_usage\": 15.5,\n \"command\": \"java\",\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/advertised-networks": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Routing"
],
"summary": "List advertised networks",
"description": "Return networks which are advertised to connected TIER0 gateway.\n",
"operationId": "GetTier1AdvertisedNetworks",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyAdvertisedNetworksListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1//infra/tier-1s//advertised-networks\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Get IDS Custom Signature Version",
"description": "Get IDS Custom Signature Version.\n",
"operationId": "GetIdsCustomSignatureVersion",
"parameters": [
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsCustomSignatureVersion"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-vmw-nsx-example-response": "{\n\"status\": \"PUBLISHED\",\n\"resource_type\": \"IdsCustomSignatureVersion\",\n\"id\": \"version-1\",\n\"display_name\": \"version-1-test\",\n\"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1\",\n\"relative_path\": \"version-1\",\n\"parent_path\": \"/infra\",\n\"unique_id\": \"3de5f815-775d-4915-a665-316795b49025\",\n\"realization_id\": \"3de5f815-775d-4915-a665-316795b49025\",\n\"owner_id\": \"5a5f68e3-b91b-4e59-9546-adba7bce6483\",\n\"marked_for_delete\": false,\n\"overridden\": false,\n\"version_id\": \"Test\",\n\"state\": \"ACTIVE\",\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_create_time\": 1717741975055,\n\"_create_user\": \"admin\",\n\"_last_modified_time\": 1717743290603,\n\"_last_modified_user\": \"admin\",\n\"_revision\": 4\n}\n"
},
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Add IDS custom signatures",
"description": "Add IDS custom signatures\n",
"operationId": "AddCustomSignatures",
"parameters": [
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action to add custom signatures",
"required": true,
"schema": {
"type": "string",
"enum": [
"ADD_CUSTOM_SIGNATURES"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRawSignatures"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1?action=ADD_CUSTOM_SIGNATURES\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-codegen-request-body-name": "IdsRawSignatures"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Read DHCP static binding",
"description": "Read DHCP static binding",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadSegmentDhcpStaticBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs/binding1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"address1\",\n \"path\": \"/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/tier-1s/mgw/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595467058,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Create or update DHCP static binding",
"description": "If binding with the binding-id is not already present,\ncreate a new DHCP static binding instance. If it already exists, replace\nthe existing DHCP static binding instance with this object.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrReplaceSegmentDhcpStaticBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\n{\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"gateway_address\": \"10.1.1.1\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"gateway_address\": \"10.1.1.1\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"lease_time\": 86400,\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n },\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"id\": \"address1\",\n \"display_name\": \"address1\",\n \"path\": \"/infra/tier-1s/mgw/segments/web1/dhcp-static-binding-configs/address1\",\n \"relative_path\": \"address1\",\n \"parent_path\": \"/infra/tier-1s/mgw/segments/web1\",\n \"unique_id\": \"32fdd5b6-e3e7-4e62-867b-fc805c9de77e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1594595467056,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1594595467058,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "DhcpStaticBindingConfig"
},
"delete": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Delete DHCP static binding",
"description": "Delete DHCP static binding",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteSegmentDhcpStaticBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs/binding1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Static Bindings",
"Segments Bindings (Fixed)"
],
"summary": "Create or update DHCP static binding",
"description": "If binding with the binding-id is not already present,\ncreate a new DHCP static binding instance. If it already exists, replace\nthe existing DHCP static binding instance with specified attributes.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchSegmentDhcpStaticBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpStaticBindingConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/segments/web_seg/dhcp-static-binding-configs/binding1\n{\n \"resource_type\": \"DhcpV4StaticBindingConfig\",\n \"gateway_address\": \"10.1.1.1\",\n \"mac_address\": \"11:22:33:44:55:67\",\n \"host_name\": \"vm1.vmware.com\",\n \"ip_address\": \"30.30.30.175\",\n \"options\": {\n \"option121\": {\n \"static_routes\": [\n {\n \"network\": \"10.22.12.1/23\",\n \"next_hop\": \"2.2.2.2\"\n },\n {\n \"network\": \"129.0.0.1/32\",\n \"next_hop\": \"0.0.0.0\"\n }\n ]\n }\n }\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "DhcpStaticBindingConfig"
}
},
"/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from tier-1 interface",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the\ntier-1 interface, on a edge node specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "GlobalInfraGetTier1InterfaceArpTable",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/locale-services/default/interfaces/to_internet/arp-table?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"displayName\",\n \"result_count\": 3,\n \"interface_path\": \"/infra/tier-1s/t1/locale-services/default/interfaces/to_internet\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\",\n example_response: |\n \"results\": [\n {\n \"mac_address\": \"00:50:56:8e:b4:21\",\n \"ip\": \"172.16.10.21\"\n },\n {\n \"mac_address\": \"02:50:56:56:44:52\",\n \"ip\": \"172.16.10.1\"\n },\n {\n \"mac_address\": \"00:50:56:8e:91:12\",\n \"ip\": \"172.16.10.11\"\n }\n ]\n}\n"
}
},
"/infra/traceflows/{traceflow-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Read traceflow config",
"description": "Read traceflow config with id traceflow-id. This configuration\nwill be cleaned up by the system after two hours of inactivity.\n",
"operationId": "ReadTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/traceflows/t1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"segment_port_path\": \"/infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:c8d7ac3f-1904-4088-a9ec-f0183b5b14d6\",\n \"packet\": {\n \"eth_header\": {\n \"src_mac\": \"00:50:56:8f:49:60\",\n \"dst_mac\": \"00:50:56:8f:2f:97\",\n \"eth_type\": 2048\n },\n \"ip_header\": {\n \"src_ip\": \"172.16.14.11\",\n \"dst_ip\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transport_header\": {\n \"icmp_echo_request_header\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"payload\": \"\",\n \"resource_type\": \"FieldsPacketData\",\n \"frame_size\": 128,\n \"routed\": true,\n \"transport_type\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"TraceflowConfig\",\n \"id\": \"t7\",\n \"display_name\": \"t7\",\n \"path\": \"/infra/traceflows/t7\",\n \"relative_path\": \"t7\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"4dbe1a62-156c-46be-a70f-ea237344f1c3\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579195094519,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579195094519,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Create or update a traceflow config",
"description": "If a traceflow config with the traceflow-id is not\nalready present, create a new traceflow config. If it already exists,\nupdate the traceflow config. This is a full replace. This\nconfiguration will be cleaned up by the system after two hours of inactivity.\nTo start traceflow on a DHCP port in a custom project, enforcement point path is required.\nUser needs to update the in-band network telemetry (INT) configuration to specify the DSCP\nbit/value for traceflow crafted packet, if the source port of traceflow is on VLAN logical network.\nThe INT configuration is under global operations configuration so please refer NSX-T API document\nPolicy > Networking > Networking Profiles > Global Gateway Configuration to check how to set the\nDSCP bit/value via global operations configuration related API.\n",
"operationId": "UpdateTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/traceflows/t14?enforcement_point_path=/infra/sites/default/enforcement-points/default\n{\n \"segment_port_path\": \"/infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:c8d7ac3f-1904-4088-a9ec-f0183b5b14d6\",\n \"packet\": {\n \"eth_header\": {\n \"src_mac\": \"00:55:56:8f:49:60\",\n \"dst_mac\": \"00:50:56:8f:2f:97\",\n \"eth_type\": 2048\n },\n \"ip_header\": {\n \"src_ip\": \"172.16.14.11\",\n \"dst_ip\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transport_header\": {\n \"icmp_echo_request_header\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"payload\": \"\",\n \"resource_type\": \"FieldsPacketData\",\n \"frame_size\": 128,\n \"routed\": true,\n \"transport_type\": \"UNICAST\"\n },\n \"timeout\": 10\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"segment_port_path\": \"/infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:c8d7ac3f-1904-4088-a9ec-f0183b5b14d6\",\n \"packet\": {\n \"eth_header\": {\n \"src_mac\": \"00:55:56:8f:49:60\",\n \"dst_mac\": \"00:50:56:8f:2f:97\",\n \"eth_type\": 2048\n },\n \"ip_header\": {\n \"src_ip\": \"172.16.14.11\",\n \"dst_ip\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transport_header\": {\n \"icmp_echo_request_header\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"payload\": \"\",\n \"resource_type\": \"FieldsPacketData\",\n \"frame_size\": 128,\n \"routed\": true,\n \"transport_type\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"TraceflowConfig\",\n \"id\": \"t14\",\n \"display_name\": \"t14\",\n \"path\": \"/infra/traceflows/t14\",\n \"relative_path\": \"t14\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"d3c59bf3-5de8-4d65-91cc-940458fc8860\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579243672065,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579243672065,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "TraceflowConfig"
},
"post": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Restart traceflow with same set of parameters used during create/update traceflow",
"description": "This will retrace even if current traceflow has observations. Current\nobservations will be lost. Traceflow configuration will be cleaned up\nby the system after two hours of inactivity.\n\n
\nPlease use PUT API to start new Traceflow sessions. By default, traceflow observations will be cleanup every two hours, \nplease use is_transient flag to avoid the cleanup.\n",
"operationId": "RestartTraceflow",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action to be performed",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "https://<policy-mgr>/policy/api/v1/infra/traceflows/t7?action=retrace\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"segment_port_path\": \"/infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:c8d7ac3f-1904-4088-a9ec-f0183b5b14d6\",\n \"packet\": {\n \"eth_header\": {\n \"src_mac\": \"00:50:56:8f:49:60\",\n \"dst_mac\": \"00:50:56:8f:2f:97\",\n \"eth_type\": 2048\n },\n \"ip_header\": {\n \"src_ip\": \"172.16.14.11\",\n \"dst_ip\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transport_header\": {\n \"icmp_echo_request_header\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"payload\": \"\",\n \"resource_type\": \"FieldsPacketData\",\n \"frame_size\": 128,\n \"routed\": true,\n \"transport_type\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"TraceflowConfig\",\n \"id\": \"t7\",\n \"display_name\": \"t7\",\n \"path\": \"/infra/traceflows/t7\",\n \"relative_path\": \"t7\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"4dbe1a62-156c-46be-a70f-ea237344f1c3\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579195094519,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579195094519,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Delete traceflow config",
"description": "Delete traceflow config with id traceflow-id",
"operationId": "DeleteTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/traceflows/t1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Create or update a traceflow config",
"description": "If a traceflow config with the traceflow-id is not\nalready present, create a new traceflow config. If it already exists,\nupdate the traceflow config. This is a full replace. This configuration\nwill be cleaned up by the system after two hours of inactivity.\nTo start traceflow on a DHCP port in a custom project, enforcement point path is required.\n\n
\nPlease use PUT API to start new Traceflow sessions. By default, traceflow observations will be cleanup every two hours, \nplease use is_transient flag to avoid the cleanup.\n",
"operationId": "PatchTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/traceflows/t12\n{\n \"segment_port_path\": \"/infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:c8d7ac3f-1904-4088-a9ec-f0183b5b14d6\",\n \"packet\": {\n \"eth_header\": {\n \"src_mac\": \"00:50:56:8f:49:60\",\n \"dst_mac\": \"00:50:56:8f:2f:97\",\n \"eth_type\": 2048\n },\n \"ip_header\": {\n \"src_ip\": \"172.16.14.11\",\n \"dst_ip\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transport_header\": {\n \"icmp_echo_request_header\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"payload\": \"\",\n \"resource_type\": \"FieldsPacketData\",\n \"frame_size\": 128,\n \"routed\": true,\n \"transport_type\": \"UNICAST\"\n },\n \"timeout\": 10\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n",
"x-codegen-request-body-name": "TraceflowConfig"
}
},
"/infra/settings/firewall/security/intrusion-services/signatures?action=update_signatures": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Download and update IDS signatures",
"description": "Trigger the process to Download and update the IDS signatures manually.\n",
"operationId": "UpdateIdsSignatures",
"responses": {
"202": {
"description": "Accepted",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/signatures?action=update_signatures\n",
"x-vmw-nsx-module": "PolicyIDS"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Get L2VPN service list result under Tier-0",
"description": "Get paginated list of all L2VPN services under Tier-0.\n\n
\nThis API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n",
"operationId": "ListL2VPNServices",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/locale-services/default/l2vpn-services\n",
"x-vmw-nsx-module": "PolicyLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-0s/ext_net/locale-services/default/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/endpoints/virtual-endpoints/{virtual-endpoint-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Virtual Endpoints",
"Tier-0 Gateways"
],
"summary": "Read virtual endpoint",
"description": "Read virtual endpoint with given id under given Tier0.",
"operationId": "ReadVirtualEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "virtual-endpoint-id",
"in": "path",
"description": "Virtual endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/endpoints/virtual-endpoints/VEP_1\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"VirtualEndpoint\",\n \"id\": \"VEP_1\",\n \"display_name\": \"VEP_1\",\n \"path\": \"/infra/tier-0s/vmc/locale-services/default/endpoints/VEP_1\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"VEP_1\",\n \"marked_for_delete\": false,\n \"target_ips\": [\n {\n \"ip_addresses\": [\n \"111.111.112.11\"\n ],\n \"prefix_length\": 32\n }\n ],\n \"service_names\": [\n \"HCX_Service\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1526676234605,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1526676234605,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Virtual Endpoints",
"Tier-0 Gateways"
],
"summary": "Create or update virtual endpoint",
"description": "Create or update virtual endpoint.\n",
"operationId": "CreateOrUpdateVirtualEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "virtual-endpoint-id",
"in": "path",
"description": "Virtual endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/endpoints/virtual-endpoints/VEP_1\n{\n \"resource_type\": \"VirtualEndpoint\",\n \"display_name\": \"VEP_1\",\n \"target_ips\": [\n {\n \"ip_addresses\": [\n \"111.111.112.11\"\n ],\n \"prefix_length\": 32\n }\n ],\n \"service_names\": [\n \"HCX_Service\"\n ]\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"VirtualEndpoint\",\n \"id\": \"VEP_1\",\n \"display_name\": \"VEP_1\",\n \"path\": \"/infra/tier-0s/vmc/locale-services/default/endpoints/virtual-endpoints/VEP_1\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"VEP_1\",\n \"marked_for_delete\": false,\n \"target_ips\": [\n {\n \"ip_addresses\": [\n \"111.111.112.11\"\n ],\n \"prefix_length\": 32\n }\n ],\n \"service_names\": [\n \"HCX_Service\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1526676234605,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1526676234605,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "VirtualEndpoint"
},
"delete": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Virtual Endpoints",
"Tier-0 Gateways"
],
"summary": "Delete virtual endpoint",
"description": "Delete virtual endpoint",
"operationId": "DeleteVirtualEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "virtual-endpoint-id",
"in": "path",
"description": "Virtual endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/endpoints/virtual-endpoints/VEP_1\n",
"x-vmw-nsx-module": "PolicyServiceInsertion"
},
"patch": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Virtual Endpoints",
"Tier-0 Gateways"
],
"summary": "Create or update virtual endpoint",
"description": "Create or update virtual endpoint.\n",
"operationId": "PatchVirtualEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "virtual-endpoint-id",
"in": "path",
"description": "Virtual endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/endpoints/virtual-endpoints/VEP_1\n{\n \"resource_type\": \"VirtualEndpoint\",\n \"display_name\": \"VEP_1\",\n \"target_ips\": [\n {\n \"ip_addresses\": [\n \"111.111.112.11\"\n ],\n \"prefix_length\": 32\n }\n ],\n \"service_names\": [\n \"HCX_Service\"\n ]\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-codegen-request-body-name": "VirtualEndpoint"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "Read a Edge Cluster under an Enforcement Point",
"description": "Read a Edge Cluster under an Enforcement Point\n",
"operationId": "ReadEdgeClusterForEnforcementPoint",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "edge-cluster-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyEdgeCluster"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyEdgeCluster\",\n \"id\": \"ec\",\n \"display_name\": \"/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec\",\n \"path\": \"/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/nsxt-ep\",\n \"relative_path\": \"ec\",\n \"nsx_id\": \"8ce97b79-e2da-4d73-bc3b-4723ccab0600\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262753660,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/physical-server-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given Physical Server is a member",
"description": "Get policy groups for which the given Physical Server is a member.\n",
"operationId": "GetGroupsForPhysicalServer",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "physical_server_external_id",
"in": "query",
"description": "Physical external ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/physical-server-group-associations?physical_server_external_id=564de333-15ac-de52-da90-974fe099a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/status": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Heatmap"
],
"summary": "Get high-level summary of a transport zone",
"description": "Get high-level summary of a transport zone",
"operationId": "GetHeatmapTZStatus",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "zone-id",
"in": "path",
"description": "ID of transport zone",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeatMapTransportZoneStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/transport-zones/TZ1/status\n",
"x-vmw-nsx-module": "PolicyHeatmap",
"x-vmw-nsx-example-response": "{\n\"down_count\": 0,\n\"unknown_count\": 2,\n\"up_count\": 0,\n\"degraded_count\": 0\n}\n"
}
},
"/infra/vni-pools": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"EVPN VNI Pools"
],
"summary": "List Vni Pool Configuration",
"description": "List all Vni Pool configuration.\n",
"operationId": "ListVniPoolConfig",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VniPoolConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyConnectivity"
}
},
"/infra/lb-services/{lb-service-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Services"
],
"summary": "Read LBService",
"description": "Read an LBService.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "ReadLBService",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/lb-services/cgwService\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LBService\",\n \"id\": \"cgwLbService\",\n \"display_name\": \"cgwLbService\",\n \"path\": \"/infra/lb-services/cgwLbService\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"cgwLbService\",\n \"marked_for_delete\": false,\n \"size\": \"SMALL\",\n \"error_log_level\": \"INFO\",\n \"access_log_enabled\": false,\n \"enabled\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1531109024949,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1531109024949,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Services"
],
"summary": "Create or update a LBService",
"description": "If a LBService with the lb-service-id is not already\npresent, create a new LBService. If it already exists, update the\nLBService. This is a full replace.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "UpdateLBService",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/lb-services/cgwService\n{\n \"resource_type\": \"LBService\",\n \"enabled\": true,\n \"size\":\"SMALL\"\n}\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LBService\",\n \"id\": \"cgwLbService\",\n \"display_name\": \"cgwLbService\",\n \"path\": \"/infra/lb-services/cgwLbService\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"cgwLbService\",\n \"marked_for_delete\": false,\n \"size\": \"SMALL\",\n \"error_log_level\": \"INFO\",\n \"access_log_enabled\": false,\n \"enabled\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1531109024949,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1531109024949,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "LBService"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Services"
],
"summary": "Delete LBService and all the entities contained by this LBService",
"description": "Delete the LBService along with all the entities contained by\nthis LBService.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "DeleteLBService",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force delete the resource even if it is being used somewhere\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/lb-services/cgwService\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Services"
],
"summary": "Create or update a LBVirtualServer",
"description": "If a LBService with the lb-service-id is not already\npresent, create a new LBService. If it already exists, update the\nLBService. This is a full replace.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "PatchLBService",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/lb-services/cgwService\n {\n \"resource_type\": \"LBService\",\n \"enabled\": true,\n \"size\":\"SMALL\"\n }\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "LBService"
}
},
"/infra/tier-0s/{tier-0-id}/static-routes": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Static Routes"
],
"summary": "List Tier-0 Static Routes",
"description": "Paginated list of all Tier-0 Static Routes\n",
"operationId": "ListTier0StaticRoutes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StaticRoutesListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/static-routes\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"StaticRoutes\",\n \"id\": \"site1\",\n \"display_name\": \"/infra/tier-0s/vmc_prv/static-routes/site1\",\n \"path\": \"/infra/tier-0s/vmc_prv/static-routes/site1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"site1\",\n \"next_hops\": [\n {\n \"ip_address\": \"41.1.1.1\",\n \"admin_distance\": 1\n },\n {\n \"ip_address\": \"42.1.1.1\",\n \"admin_distance\": 2\n },\n {\n \"ip_address\": \"43.1.2.3\",\n \"admin_distance\": 3\n }\n ],\n \"network\": \"45.1.1.0/24\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516750267338,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516750267338,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments (Fixed)"
],
"summary": "List all effective profiles for segment",
"description": "List all effective profiles for this segment on given enforcement point.",
"operationId": "GlobalInfraListSegmentEffectiveProfiles",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectiveProfilesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/tier1-ls/effective-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/infra/settings/firewall/security/intrusion-services/signatures/status": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Get IDS signature status",
"description": "Intrusion detection system signatures status.\n",
"operationId": "GetIdsSignatureStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsSignatureStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/signatures/status\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"download_status\": \"READY\",\n \"signature_status\": \"AVAILABLE\",\n \"version_id\": \"23a830d05aee6a16dcd59027bbe5e3ab8b381297\",\n \"resource_type\": \"IdsSignatureStatus\",\n \"id\": \"status\",\n \"display_name\": \"status\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/signatures/status\",\n \"relative_path\": \"status\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"e30efc81-4148-4b8a-a785-6044bd381b53\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1582715396103,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1582715412998,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Revise the positioning of IDS security policies",
"description": "This is used to set a precedence of a security policy w.r.t others.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReviseIdsSecurityPolicy",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsSecurityPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsSecurityPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp12?action=revise&anchor_path=/infra/domains/default/intrusion-service-policies/sp14&operation=insert_before\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp12\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp12\",\n \"relative_path\": \"sp12\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"a3aaa996-2c03-482a-af44-06b2c7ec4937\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 5100,\n \"internal_sequence_number\": 5100,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711475948,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582713848556,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 12\n }\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp12\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp12\",\n \"relative_path\": \"sp12\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"a3aaa996-2c03-482a-af44-06b2c7ec4937\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 2500,\n \"internal_sequence_number\": 2500,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711475948,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714047068,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 14\n}\n",
"x-codegen-request-body-name": "IdsSecurityPolicy"
}
},
"/infra/settings/firewall/idfw/user-stats/{user-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Get IDFW user login events for a given user",
"description": "It will get IDFW user login events for a given user.\n",
"operationId": "GetUserLoginEvents",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "User id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdfwUserStats"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-ip>/policy/api/v1/infra/settings/firewall/idfw/user-stats/<user-id>\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"active_sessions\": [{\n \"domain_name\": \"nimbustest.com\",\n \"vm_ext_id\": \"a6bc2d10-e98c-4a0c-a2e7-936eaec657e0\",\n \"user_id\": {\n \"is_valid\": true,\n \"target_type\": \"DirectoryUser\",\n \"target_id\": \"bee4cf12-9cb8-4b24-8604-a088d12efe0d\"\n },\n \"user_name\": \"test6\",\n \"login_time\": 1539209859091,\n \"logout_time\": 0,\n \"user_session_id\": 2\n }],\n \"user\": {\n \"is_valid\": true,\n \"target_type\": \"DirectoryUser\",\n \"target_id\": \"bee4cf12-9cb8-4b24-8604-a088d12efe0d\"\n },\n \"archived_sessions\": [{\n \"domain_name\": \"nimbustest.com\",\n \"vm_ext_id\": \"a6bc2d10-e98c-4a0c-a2e7-936eaec657e0\",\n \"user_id\": {\n \"is_valid\": true,\n \"target_type\": \"DirectoryUser\",\n \"target_id\": \"bee4cf12-9cb8-4b24-8604-a088d12efe0d\"\n },\n \"user_name\": \"test6\",\n \"login_time\": 1539209850318,\n \"logout_time\": 1539209852692,\n \"user_session_id\": 1\n }]\n}\n"
}
},
"/infra/sha/runbook-artifacts/{request-id}/artifact": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "Download the collection of artifacts generated by an Online Diagnostic System runbook invocations",
"description": "Download the collection of artifacts generated by an Online Diagnostic System runbook invocations.\nPlease add the below header in the http request, if it is not present\nAccept application/octet-stream\n",
"operationId": "LoadOdsInvocationArtifactInBatch",
"parameters": [
{
"name": "request-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyOds"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "List Tier-0 Interfaces",
"description": "Paginated list of all Tier-0 Interfaces\n",
"operationId": "GlobalInfraListTier0Interfaces",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0InterfaceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/interfaces\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Tier0Interface\",\n \"id\": \"to_internet\",\n \"display_name\": \"to_internet\",\n \"path\": \"/infra/tier-0s/vmc_prv/locale-services/default/interfaces/to_internet\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv/locale-services/default\",\n \"relative_path\": \"to_internet\",\n \"segment_path\": \"/infra/segments/sg-uplink\",\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"edge_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\",\n \"type\": \"EXTERNAL\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/segments": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get segments that belong to this Group",
"description": "Get segments that belong to this Group\n",
"operationId": "GetGroupSegmentMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/segments?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"id\": \"segment-1\",\n \"display_name\": \"segment-1\",\n \"path\": \"/infra/segments/segment-1\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "List Segment Discovery Profile Binding Maps",
"description": "API will list all Segment Discovery Profile Binding Maps in current segment id.\n",
"operationId": "ListSegmentDiscoveryBindings",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentDiscoveryProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-discovery-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"sdpbm_1\",\n \"display_name\": \"SegmentDiscoveryProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-discovery-profile-binding-maps/sdpbm_1\",\n \"relative_path\": \"SegmentDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/intrusion-service-policies": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "List IDS security policies",
"description": "List intrusion detection system security policies.\n",
"operationId": "ListIdsSecurityPolicies",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsSecurityPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp12\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp12\",\n \"relative_path\": \"sp12\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"a3aaa996-2c03-482a-af44-06b2c7ec4937\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 2500,\n \"internal_sequence_number\": 2500,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711475948,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714047068,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 14\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp16\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp16\",\n \"relative_path\": \"sp16\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"445aaefb-6d0a-4e19-bd62-f56c1e0870e1\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 5000,\n \"internal_sequence_number\": 5000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582713996647,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046874,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp17\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp17\",\n \"relative_path\": \"sp17\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"adf57370-853e-4db8-b248-393d7fb4e88e\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 10000,\n \"internal_sequence_number\": 10000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582714000481,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046893,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp15\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp15\",\n \"relative_path\": \"sp15\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"c83df674-3879-4ef7-8b79-d562f14ff2ef\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 15000,\n \"internal_sequence_number\": 15000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582713987733,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046919,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp13\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp13\",\n \"relative_path\": \"sp13\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"85816222-5cee-4135-b524-377bd00f4e70\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 20000,\n \"internal_sequence_number\": 20000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711483215,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046963,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 14\n },\n {\n \"resource_type\": \"IdsSecurityPolicy\",\n \"id\": \"sp14\",\n \"display_name\": \"test-ids-security-policy\",\n \"description\": \"test-ids-security-policy\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp14\",\n \"relative_path\": \"sp14\",\n \"parent_path\": \"/infra/domains/default\",\n \"unique_id\": \"17d3909c-d8cd-4809-94e8-1f6215496dd7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"sequence_number\": 25000,\n \"internal_sequence_number\": 25000,\n \"stateful\": true,\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582711487000,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582714046987,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 10\n }\n],\n\"result_count\": 6,\n\"sort_by\": \"sequence_number\",\n\"sort_ascending\": true\n }\n"
}
},
"/infra/sites/listener_certificate": {
"get": {
"tags": [
"Federation",
"Sites"
],
"summary": "Returns the certificate of the listener",
"description": "Connects to the given IP and port, and, if an SSL listener is present, returns\nthe certificate of the listener.\nIntent of this API is \"Do you trust this certificate?\".\n",
"operationId": "GetInfraSiteListenerCertificate",
"parameters": [
{
"name": "address",
"in": "query",
"description": "Host name or IP address of TLS listener",
"required": true,
"schema": {
"type": "string",
"format": "hostname-or-ip"
}
},
{
"name": "port",
"in": "query",
"description": "TCP port number of the TLS listener",
"required": true,
"schema": {
"maximum": 65535,
"minimum": 0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsListenerCertificate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/global-policy/api/v1/infra/sites/listener_certificate?address=10.22.122.7&port=443\n",
"x-vmw-nsx-module": "PolicySiteGM",
"x-vmw-nsx-example-response": "{\n \"result\": \"SUCCESS\",\n \"certificate\": {\n \"issuer_cn\": \"vSM Test Certificate\",\n \"public_key_length\": 1024,\n \"signature\": \"4e cf ff 36 ac a1\",\n \"not_before\": 1323772715000,\n \"subject\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"serial_number\": \"ca55f5e21a0b2dd2\",\n \"public_key_algo\": \"RSA\",\n \"version\": \"1\",\n \"issuer\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"is_ca\": false,\n \"subject_cn\": \"vSM Test Certificate\",\n \"not_after\": 1355308715000,\n \"is_valid\": false,\n \"rsa_public_key_exponent\": \"10001\",\n \"signature_algorithm\": \"SHA1WITHRSA\",\n \"rsa_public_key_modulus\": \"00 b7 8f 79 e4\"\n },\n \"thumbprint\": \"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\"\n}\n"
}
},
"/global-infra/segments/{segment-id}/ports/{port-id}/mac-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"MAC Table"
],
"summary": "Get MAC table for infra segment port",
"description": "Returns MAC table for a segment port\n",
"operationId": "GlobalInfraGetInfraSegmentPortMacTable",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortMacAddressListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWN_LINK_SWITCH/ports/default:d808cd01-b20b-485b-8e57-983a84fa7642/mac-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"transport_node_id\": \"01b3242e-a7c8-11ea-9a01-278a0b44b8c9\",\n \"last_update_timestamp\": 1591767152521,\n \"results\": [\n {\n \"mac_address\": \"00:0c:29:ce:0f:77\",\n \"mac_type\": \"STATIC\"\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Edge Bridge Profiles"
],
"summary": "Get L2 Bridge Endpoint Profile",
"description": "Read L2 bridge profile with ID profile-id",
"operationId": "ReadL2BridgeProfile",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2BridgeEndpointProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-points/default/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\"\n ],\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"failover_mode\": \"PREEMPTIVE\",\n \"resource_type\": \"L2BridgeEndpointProfile\",\n \"id\": \"p1\",\n \"display_name\": \"p1\",\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1\",\n \"relative_path\": \"p1\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n \"unique_id\": \"e2292681-5309-4954-8ad9-4ee89430d10d\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579296574896,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579296574896,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Edge Bridge Profiles"
],
"summary": "Create or update L2 Bridge Endpoint Profile",
"description": "API will create or update L2 bridge profile with ID profile-id.\nL2 Bridge profile is only allowed under an enforcement-point with path\n/infra/sites/default/enforcement-points/default.\n",
"operationId": "UpdateL2BridgeProfile",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2BridgeEndpointProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2BridgeEndpointProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1\n{\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-points/default/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\"\n ],\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"failover_mode\": \"PREEMPTIVE\",\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-points/default/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\"\n ],\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"failover_mode\": \"PREEMPTIVE\",\n \"resource_type\": \"L2BridgeEndpointProfile\",\n \"id\": \"p1\",\n \"display_name\": \"p1\",\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1\",\n \"relative_path\": \"p1\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n \"unique_id\": \"e2292681-5309-4954-8ad9-4ee89430d10d\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579296574896,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579296574896,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "L2BridgeEndpointProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Edge Bridge Profiles"
],
"summary": "Delete L2 Bridge Endpoint Profile",
"description": "API will delete L2 bridge profile with ID profile-id",
"operationId": "DeleteL2BridgeProfile",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Edge Bridge Profiles"
],
"summary": "Create or update L2 Bridge Endpoint Profile",
"description": "API will create or update L2 bridge profile with ID profile-id.\nL2 Bridge profile is only allowed under an enforcement-point with path\n/infra/sites/default/enforcement-points/default.\n",
"operationId": "PatchL2BridgeProfile",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile-id",
"in": "path",
"description": "profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2BridgeEndpointProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1\n{\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-points/default/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\"\n ],\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"failover_mode\": \"PREEMPTIVE\",\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n",
"x-codegen-request-body-name": "L2BridgeEndpointProfile"
}
},
"/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "List all threshold configurations for IDS system signature",
"description": "List all threshold configurations for IDS signatures.\nThis API is applicable only for 'System' signatures.\n",
"operationId": "ListIdsSignatureThresholdConfigs",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsThresholdConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"threshold\": {\n \"threshold_type\": \"THRESHOLD\",\n \"count\": 6,\n \"time_period\": 65,\n \"track_by\": \"SOURCE\"\n },\n \"rate_filter\": {\n \"new_action\": \"DROP\",\n \"count\": 22,\n \"time_period\": 23,\n \"timeout\": 23\n },\n \"resource_type\": \"IdsThresholdConfig\",\n \"id\": \"1060759\",\n \"display_name\": \"1060759\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs/1060759\",\n \"relative_path\": \"1060759\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"d8c6c01a-4386-41a1-bc57-831f849bd9a8\",\n \"realization_id\": \"d8c6c01a-4386-41a1-bc57-831f849bd9a8\",\n \"owner_id\": \"2f8b11ae-5293-422e-9717-d1eedd7afd44\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1718318662395,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1718318662395,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"threshold\": {\n \"threshold_type\": \"THRESHOLD\",\n \"count\": 55,\n \"time_period\": 58,\n \"track_by\": \"SOURCE\"\n },\n \"resource_type\": \"IdsThresholdConfig\",\n \"id\": \"1061143\",\n \"display_name\": \"1061143\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs/1061143\",\n \"relative_path\": \"1061143\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"87685a61-6f77-4a24-8399-9e21c0ed706c\",\n \"realization_id\": \"87685a61-6f77-4a24-8399-9e21c0ed706c\",\n \"owner_id\": \"2f8b11ae-5293-422e-9717-d1eedd7afd44\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1718318662447,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1718318662447,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"rate_filter\": {\n \"new_action\": \"DROP\",\n \"count\": 46,\n \"time_period\": 46,\n \"timeout\": 46\n },\n \"resource_type\": \"IdsThresholdConfig\",\n \"id\": \"1061156\",\n \"display_name\": \"1061156\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs/1061156\",\n \"relative_path\": \"1061156\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"24278a48-497f-4675-9f40-69f3e09875c6\",\n \"realization_id\": \"24278a48-497f-4675-9f40-69f3e09875c6\",\n \"owner_id\": \"2f8b11ae-5293-422e-9717-d1eedd7afd44\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1718318662456,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1718318662456,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 3,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DNS",
"DNS Forwarder",
"Tier-1 Gateways"
],
"summary": "Resolve a given address via the dns forwarder at Tier1",
"description": "Query the nameserver for an ip-address or a FQDN of the given an address optionally using\nan specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it.\nIf the address is an ip-address, do a reverse lookup and answer fqdn(s).\nIf enforcement point is specified, then DNS forwarder nslookup answer will get fetched from\nspecified enforcement point. Otherwise from all enforcement points.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraLookupAddressViaTier1DNSForwarder",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "address",
"in": "query",
"description": "IP address or FQDN for nslookup",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatePolicyDnsAnswer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1/dns-forwarder/nslookup?address=vmware.com&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyDnsForwarder",
"x-vmw-nsx-example-response": "{\n \"dns_answer_per_enforcement_point\": [\n {\n \"resource_type\": \"NsxTDnsAnswer\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"dns_server\" : \"10.117.0.1#53\",\n \"edge_node_id\" : \"e2fa39aa-f4ca-4781-ac48-60a6c47d34e0\",\n \"authoritative_answer\" : [ {\n \"name\": \"vmware.com\"\n \"address\": \"10.113.63.149\"\n } ]\n }\n ],\n \"intent_path\": \"/infra/tier-1s/tier1/dns-forwarder\"\n}\n"
}
},
"/infra/flood-protection-profiles/{flood-protection-profile-id}/bindings": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profiles"
],
"summary": "List Flood Protection Profiles",
"description": "API will list all Flood Protection Profiles bindings.",
"operationId": "ListFloodProtectionProfileBindings",
"parameters": [
{
"name": "flood-protection-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/flood-protection-profiles/profile-1/bindings\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"name\": \"default\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\" : \"/infra/flood-protection-profiles/profile-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tier-0 Deployment Maps"
],
"summary": "Read a Tier-0 Deployment Map",
"description": "Read a Tier-0 Deployment Map\n",
"operationId": "GlobalInfraReadTier0DeploymentMap",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-0-deployment-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0DeploymentMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/tier-0-deployment-maps/vmc_t0dm\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Tier0DeploymentMap\",\n \"id\": \"vmc_t0dm\",\n \"display_name\": \"vmc_t0dm\",\n \"path\": \"/infra/tier-0s/vmc/locale-services/default/tier-0-deployment-maps/vmc_t0dm\",\n \"parent_path\": \"/infra/tier-0s/vmc/locale-services/default\",\n \"relative_path\": \"vmc_t0dm\",\n \"enforcement_point\": \"/infra/deployment-zones/default/enforcement-points/nsxt-ep\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667391141,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667391141,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/reactions": {
"get": {
"tags": [
"Policy",
"Infra",
"Reactions"
],
"summary": "Get Reaction list result",
"description": "Get paginated list of all Reactions under Infra.\n",
"operationId": "ListInfraReactions",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReactionListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/reactions\n",
"x-vmw-nsx-module": "PolicyReaction",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 2,\n \"results\" : [ {\n \"id\": \"add-ipsec-vpn-path-to-label-refs\",\n \"display_name\": \"add-ipsec-vpn-path-to-label-refs\",\n \"description\": \"React to IPSec VPN Session creation/update by adding it to a specific label refs.\",\n \"path\": \"/infra/reactions/add-ipsec-vpn-path-to-label-refs\",\n \"parent_path\": \"/infra/reactions/add-ipsec-vpn-path-to-label-refs\",\n \"relative_path\": \"add-ipsec-vpn-path-to-label-refs\",\n \"events\": [\n {\n \"source\": {\n \"resource_type\": \"ResourceOperation\",\n \"resource_pointer\": \"/infra/tier-0s/vmc/locale-services/default/ipsec-vpn-services/default/sessions/*\",\n \"operation_types\": [\n \"POST_CREATE\",\n \"POST_UPDATE\"\n ]\n },\n \"criteria\": [\n {\n \"evaluations\": [\n {\n \"resource_type\": \"SourceFieldEvaluation\",\n \"field_pointer\": \"local_endpoint_path\",\n \"operator\": \"EQ\",\n \"expected\": [\n \"/infra/tier-0s/vmc/locale-services/default/ipsec-vpn-services/default/local-endpoints/public\"\n ]\n }\n ]\n }\n ]\n }\n ],\n \"actions\": [\n {\n \"resource_type\": \"PatchResources\",\n \"injections\": [\n {\n \"key\": \"\",\n \"value\": {\n \"resource_type\": \"UnaryOperationBasedInjectionValue\",\n \"initial_value\": {\n \"path\": \"/infra/labels/public-vpn-label\",\n \"field_pointer\": \"id\"\n }\n }\n },\n {\n \"key\": \"\",\n \"value\": {\n \"resource_type\": \"UnaryOperationBasedInjectionValue\",\n \"initial_value\": {\n \"path\": \"/infra/labels/public-vpn-label\",\n \"field_pointer\": \"display_name\"\n }\n }\n },\n {\n \"key\": \"\",\n \"value\": {\n \"resource_type\": \"UnaryOperationBasedInjectionValue\",\n \"initial_value\": {\n \"path\": \"/infra/labels/public-vpn-label\",\n \"field_pointer\": \"description\"\n }\n }\n },\n {\n \"key\": \"\",\n \"value\": {\n \"resource_type\": \"UnaryOperationBasedInjectionValue\",\n \"initial_value\": {\n \"path\": \"/infra/labels/public-vpn-label\",\n \"field_pointer\": \"type\"\n }\n }\n },\n {\n \"key\": \"\",\n \"value\": {\n \"resource_type\": \"UnaryOperationBasedInjectionValue\",\n \"initial_value\": {\n \"path\": \"/infra/labels/public-vpn-label\",\n \"field_pointer\": \"refs\"\n },\n \"operation\": {\n \"operator\": \"APPEND\",\n \"operand\": {\n \"field_pointer\": \"path\"\n }\n }\n }\n }\n ],\n \"body\": {\n \"resource_type\": \"Infra\",\n \"children\": [\n {\n \"resource_type\": \"ChildPolicyLabel\",\n \"PolicyLabel\": {\n \"resource_type\": \"PolicyLabel\",\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"refs\": \"\"\n }\n }\n ]\n }\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516385949942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516385949942,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\" : 0\n },\n {\n \"id\": \"auto-connect-tier-1\",\n \"display_name\": \"auto-connect-tier-1\",\n \"description\": \"React to Tier-1 creation/update by auto-connecting it to vmc tier-0\",\n \"events\": [\n {\n \"source\": {\n \"resource_type\": \"ApiRequestBody\",\n \"resource_pointer\": \"Tier1\"\n }\n }\n ],\n \"actions\": [\n {\n \"resource_type\": \"SetFields\",\n \"field_settings\": [\n {\n \"field_pointer\": \"tier0_path\",\n \"value\": {\n \"resource_type\": \"ConstantFieldValue\",\n \"constant\": \"/infra/tier-0s/vmc\"\n }\n }\n ]\n }\n ]\n } ]\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Bridge Endpoints",
"Statistics"
],
"summary": "Get Tier-1 segment bridge end point status using segment ID and profile path.",
"description": "Get detailed information on Tier-1 segment bridge end point status using segment ID and profile path.\n",
"operationId": "GlobalInfraTier1SegmentBridgeEndpointStatus",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bridge_profile_path",
"in": "query",
"description": "Bridge profile path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BridgeEndpointStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "# TODO: change this sample request after api is tested\nGET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment-1/bep-status?bridge_profile_path=/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{ # TODO: change this sample response after api is tested\n \"active_nodes\": [\n /infra/sites/default/enforcement-points/default/host-transport-nodes/TN1\n ],\n \"last_update_timestamp\": 1457547568679,\n \"endpoint_id\": \"15269939-779a-4fa4-9a0a-792dbf9fac12\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/mac-table": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"Port",
"Statistics"
],
"summary": "Get MAC table for VPC Subnet port",
"description": "Returns MAC table for a VPC Subnet port\n",
"operationId": "GetVpcSubnetPortMacTable",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortMacAddressListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ports/default:d808cd01-b20b-485b-8e57-983a84fa7642/mac-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyVpcSubnetStatistics",
"x-vmw-nsx-example-response": "{\n \"transport_node_id\": \"01b3242e-a7c8-11ea-9a01-278a0b44b8c9\",\n \"last_update_timestamp\": 1591767152521,\n \"results\": [\n {\n \"mac_address\": \"00:0c:29:ce:0f:77\",\n \"mac_type\": \"STATIC\"\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get statistics for downlink router port on tier-1 router",
"description": "Segment ID is the ID of the segment that is connected to the the tier-1\n",
"operationId": "GetDownlinkPortStatisticsForTier1Segment",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH/gateway-interface-statistics?edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/7f7d37a7-b78e-4378-949d-09190cbfef7d/edge-nodes/a831390e-a7c8-11ea-9102-020063e79023\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_router_port_id\": \"/infra/tier-1s/TLR1_LR\",\n \"per_node_statistics\": [\n {\n \"last_update_timestamp\": 1591806707306,\n \"rx\": {\n \"total_bytes\": 78780,\n \"total_packets\": 1313,\n \"dropped_packets\": 94459\n },\n \"tx\": {\n \"total_bytes\": 57559796,\n \"total_packets\": 813354,\n \"dropped_packets\": 94459\n }\n }\n ]\n}\n"
}
},
"/infra/sandboxed-resources": {
"get": {
"tags": [
"Policy",
"Sandboxing"
],
"summary": "Get sandbox resources",
"description": "Get sandbox resources\n",
"operationId": "GetSandboxedResources",
"parameters": [
{
"name": "intent_path",
"in": "query",
"description": "intent path",
"schema": {
"type": "string"
}
},
{
"name": "site_path",
"in": "query",
"description": "site path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SandboxedResourceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "SandboxVisibility"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/cloud-native-service-instances": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Effective Cloud Native Service Instances that belong to this group.",
"description": "Returns Effective Cloud Native Service Instances that belong to this group.\nThis API is applicable only for Groups containing CloudNativeServiceInstance member type.\nFor Groups containing other member types,it returns an empty list.\n",
"operationId": "GetGroupCloudNativeServiceInstances",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/cloud-native-service-instances?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n\"cursor\" : \"00361f148bdc-fe7c-4320-8ef3-594e28d57c87Iws-2\",\n\"result_count\" : 1,\n\"results\" : [\n {\n \"display_name\" : \"CNS-2\",\n \"id\" : \"420e72c9-55e7-a4f7-81bf-673a2af1a6cf\"\n }\n ]\n}\n"
}
},
"/global-infra/full-sync-states": {
"get": {
"tags": [
"Federation",
"Full Synchronization"
],
"summary": "List full sync states",
"description": "List full sync state.",
"operationId": "GlobalInfraListFullSyncStates",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullSyncStateListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/full-sync-states\n",
"x-vmw-nsx-module": "PolicyFullSync",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [\n \"resource_type\": \"FullSyncState\",\n \"id\": \"1234\",\n \"full_sync_id\": \"1234\",\n \"last_completed_stage\": \"PROCESSED_DELTAS\",\n \"path\": \"/infra/fullsync-states/1234\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"1234\",\n \"_create_user\": \"SYSTEM\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"SYSTEM\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": true,\n \"_revision\": 2\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/cluster-control-planes-heartbeat-config": {
"get": {
"tags": [
"System Administration",
"Monitoring",
"System Health",
"Container",
"Antrea"
],
"summary": "Read Antrea cluster heartbeat config list",
"description": "Paginated list of all Antrea cluster heartbeat config",
"operationId": "ListAntreaHeartbeatConfig",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AntreaHeartbeatConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/cluster-control-planes-heartbeat-config\n",
"x-vmw-nsx-module": "PolicyAntreaMonitoring",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"report_interval\": 60,\n \"resource_type\": \"AntreaHeartbeatConfig\",\n \"id\": \"heartbeat-config\",\n \"display_name\": \"heartbeat-config\",\n \"path\": \"/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01/heartbeat-config\",\n \"relative_path\": \"heartbeat-config\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default/cluster-control-planes/cluster01\",\n \"unique_id\": \"cd51b604-2b51-4c3a-a646-671d6918a400\",\n \"realization_id\": \"cd51b604-2b51-4c3a-a646-671d6918a400\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1623401241169,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1623401241169,\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Tunnels"
],
"summary": "Get policy Tunnel(GRE as of now) statistics for given tunnel-id",
"description": "Get policy Tunnel(GRE as of now) statistics for given tunnel-id",
"operationId": "getPolicyTunnelStatistics",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-svc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tunnel-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelTrafficStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/tunnels/site1-tunnel/statistics\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"destination\": \"44.44.44.10\",\n \"per_edge_node_statistics\": [\n {\n \"source\": \"40.40.40.1\",\n \"logical_router_port_id\": \"4aaaf496-e99d-41f6-8d67-f9a919210eb6\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/0\",\n \"last_update_timestamp\": 1689828984784,\n \"rx\": {\n \"total_bytes\": 676292,\n \"total_packets\": 12677,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"destination_unsupported_dropped_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"ipv6_dropped_packets\": 0,\n \"kni_dropped_packets\": 0,\n \"l4port_unsupported_dropped_packets\": 0,\n \"malformed_dropped_packets\": 0,\n \"no_receiver_dropped_packets\": 0,\n \"no_route_dropped_packets\": 0,\n \"proto_unsupported_dropped_packets\": 0,\n \"redirect_dropped_packets\": 0,\n \"rpf_check_dropped_packets\": 0,\n \"ttl_exceeded_dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 445946,\n \"total_packets\": 8542,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"dad_dropped_packets\": 0,\n \"frag_needed_dropped_packets\": 0,\n \"ipsec_pol_block_dropped_packets\": 0,\n \"ipsec_pol_err_dropped_packets\": 0,\n \"no_arp_dropped_packets\": 0,\n \"no_linked_dropped_packets\": 0,\n \"no_mem_dropped_packets\": 0,\n \"non_ip_dropped_packets\": 0,\n \"service_insert_dropped_packets\": 0\n },\n \"transport_node_id\": \"bbce032f-3414-4421-ae16-2f36216cd34d\"\n },\n {\n \"source\": \"40.40.40.2\",\n \"logical_router_port_id\": \"418c4d6f-9061-4460-b374-f9a7a74c94de\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/1\",\n \"last_update_timestamp\": 1689828985117,\n \"rx\": {\n \"total_bytes\": 671025,\n \"total_packets\": 12599,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"destination_unsupported_dropped_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"ipv6_dropped_packets\": 0,\n \"kni_dropped_packets\": 0,\n \"l4port_unsupported_dropped_packets\": 0,\n \"malformed_dropped_packets\": 0,\n \"no_receiver_dropped_packets\": 0,\n \"no_route_dropped_packets\": 0,\n \"proto_unsupported_dropped_packets\": 0,\n \"redirect_dropped_packets\": 0,\n \"rpf_check_dropped_packets\": 0,\n \"ttl_exceeded_dropped_packets\": 0\n },\n \"tx\": {\n \"total_bytes\": 443140,\n \"total_packets\": 8481,\n \"dropped_packets\": 0,\n \"blocked_packets\": 0,\n \"firewall_dropped_packets\": 0,\n \"ipsec_dropped_packets\": 0,\n \"ipsec_no_sa_dropped_packets\": 0,\n \"ipsec_no_vti_dropped_packets\": 0,\n \"dad_dropped_packets\": 0,\n \"frag_needed_dropped_packets\": 0,\n \"ipsec_pol_block_dropped_packets\": 0,\n \"ipsec_pol_err_dropped_packets\": 0,\n \"no_arp_dropped_packets\": 0,\n \"no_linked_dropped_packets\": 0,\n \"no_mem_dropped_packets\": 0,\n \"non_ip_dropped_packets\": 0,\n \"service_insert_dropped_packets\": 0\n },\n \"transport_node_id\": \"59455d97-0c55-44e1-b392-aac4eb6cba5a\"\n }\n ],\n \"resource_type\": \"TUNNEL\"\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/byod-service-instances": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-0 Gateways"
],
"summary": "Read all BYOD service instance objects under a tier-0",
"description": "Read all BYOD service instance objects under a tier-0",
"operationId": "ListByodPolicyServiceInstancesForTier0",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByodPolicyServiceInstanceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/byod-service-instances\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n\"sort_ascending\": true,\n\"sort_by\": \"display_name\",\n\"result_count\": 1,\n\"results\": [\n{\n \"resource_type\": \"ByodPolicyServiceInstance\",\n \"description\": \"Byod HCX Test 1\",\n \"id\": \"BYOD_PSI_HCX\",\n \"display_name\": \"BYOD_PSI_HCX\",\n \"path\": \"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_HCX\",\n \"parent_path\": \"/infra/tier-0s/vmc\",\n \"relative_path\": \"BYOD_PSI_HCX\",\n \"marked_for_delete\": false,\n \"transport_type\": \"L3_ROUTED\",\n \"partner_service_name\": \"HCX\",\n \"deployment_mode\": \"STAND_ALONE\",\n \"_create_time\": 1527419235170,\n \"_last_modified_user\": \"admin\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_last_modified_time\": 1527419235170,\n \"_create_user\": \"admin\",\n \"_revision\": 0\n}\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"IP Discovery Profiles"
],
"summary": "Get IP Discovery Profile",
"description": "API will get IP Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIPDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-discovery-profile-id",
"in": "path",
"description": "IP Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPDiscoveryProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/ip-discovery-profiles/ipdp1\n",
"x-vmw-nsx-module": "PolicyIpDiscovery",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IPDiscoveryProfile\",\n \"display_name\": \"IPDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/ip-discovery-profiles/ipdp1\",\n \"relative_path\": \"ipdp1\",\n \"ip_v4_discovery_options\": {\n \"arp_snooping_config\": {\n \"arp_snooping_enabled\": false,\n \"arp_binding_limit\": 1\n },\n \"dhcp_snooping_enabled\": false,\n \"vmtools_enabled\": true\n },\n \"ip_v6_discovery_options\": {\n \"nd_snooping_config\": {\n \"nd_snooping_enabled\": true,\n \"nd_snooping_limit\": 2\n },\n \"dhcp_snooping_v6_enabled\": true,\n \"vmtools_v6_enabled\": true\n },\n \"tofu_enabled\": true,\n \"arp_nd_binding_timeout\": 10,\n \"duplicate_ip_detection\": {\n \"duplicate_ip_detection_enabled\": false\n },\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"IP Discovery Profiles"
],
"summary": "Update IP Discovery Profile",
"description": "API will update IP Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateIPDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-discovery-profile-id",
"in": "path",
"description": "IP Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPDiscoveryProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPDiscoveryProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/ip-discovery-profiles/ipdp1\n{\n \"resource_type\": \"IPDiscoveryProfile\",\n \"display_name\": \"IPDiscoveryProfile\",\n \"description\": \"\",\n \"ip_v4_discovery_options\": {\n \"arp_snooping_config\": {\n \"arp_snooping_enabled\": false,\n \"arp_binding_limit\": 1\n },\n \"dhcp_snooping_enabled\": false,\n \"vmtools_enabled\": true\n },\n \"ip_v6_discovery_options\": {\n \"nd_snooping_config\": {\n \"nd_snooping_enabled\": true,\n \"nd_snooping_limit\": 2\n },\n \"dhcp_snooping_v6_enabled\": true,\n \"vmtools_v6_enabled\": true\n },\n \"tofu_enabled\": true,\n \"arp_nd_binding_timeout\": 10,\n \"duplicate_ip_detection\": {\n \"duplicate_ip_detection_enabled\": false\n }\n}\n",
"x-vmw-nsx-module": "PolicyIpDiscovery",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IPDiscoveryProfile\",\n \"display_name\": \"IPDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/ip-discovery-profiles/ipdp1\",\n \"relative_path\": \"ipdp1\",\n \"ip_v4_discovery_options\": {\n \"arp_snooping_config\": {\n \"arp_snooping_enabled\": false,\n \"arp_binding_limit\": 1\n },\n \"dhcp_snooping_enabled\": false,\n \"vmtools_enabled\": true\n },\n \"ip_v6_discovery_options\": {\n \"nd_snooping_config\": {\n \"nd_snooping_enabled\": true,\n \"nd_snooping_limit\": 2\n },\n \"dhcp_snooping_v6_enabled\": true,\n \"vmtools_v6_enabled\": true\n },\n \"tofu_enabled\": true,\n \"arp_nd_binding_timeout\": 10,\n \"duplicate_ip_detection\": {\n \"duplicate_ip_detection_enabled\": false\n },\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "IPDiscoveryProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"IP Discovery Profiles"
],
"summary": "Delete IP Discovery Profile",
"description": "API will delete IP Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteIPDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-discovery-profile-id",
"in": "path",
"description": "IP Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/ip-discovery-profiles/ipdp1\n",
"x-vmw-nsx-module": "PolicyIpDiscovery"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"IP Discovery Profiles"
],
"summary": "Create IP Discovery Profile",
"description": "API will create IP Discovery profile.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateIPDiscoveryProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-discovery-profile-id",
"in": "path",
"description": "IP Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPDiscoveryProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/ip-discovery-profiles/ipdp1\n{\n \"resource_type\": \"IPDiscoveryProfile\",\n \"display_name\": \"IPDiscoveryProfile\",\n \"description\": \"\",\n \"ip_v4_discovery_options\": {\n \"arp_snooping_config\": {\n \"arp_snooping_enabled\": false,\n \"arp_binding_limit\": 1\n },\n \"dhcp_snooping_enabled\": false,\n \"vmtools_enabled\": true\n },\n \"ip_v6_discovery_options\": {\n \"nd_snooping_config\": {\n \"nd_snooping_enabled\": true,\n \"nd_snooping_limit\": 2\n },\n \"dhcp_snooping_v6_enabled\": true,\n \"vmtools_v6_enabled\": true\n },\n \"tofu_enabled\": true,\n \"arp_nd_binding_timeout\": 10,\n \"duplicate_ip_detection\": {\n \"duplicate_ip_detection_enabled\": false\n }\n}\n",
"x-vmw-nsx-module": "PolicyIpDiscovery",
"x-codegen-request-body-name": "IPDiscoveryProfile"
}
},
"/global-infra/tier-1s/{tier-1-id}/forwarding-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Routing",
"Forwarding Table"
],
"summary": "Get forwarding table from tier-1 in CSV format",
"description": "Get forwarding table from tier-1 gateway in CSV format.\n",
"operationId": "GlobalInfraGetTier1ForwardingTableCsv",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "component_type",
"in": "query",
"description": "Define the DR routes.",
"schema": {
"type": "string",
"enum": [
"DR_ROUTES"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_id",
"in": "query",
"description": "UUID of edge node",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "network_prefix",
"in": "query",
"description": "IPAddress or CIDR Block",
"schema": {
"type": "string",
"format": "address-or-cidr-block"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "route_source",
"in": "query",
"description": "Filter routes based on the source from which route is learned",
"schema": {
"type": "string",
"enum": [
"BGP",
"STATIC",
"CONNECTED",
"OSPF"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/GatewayRouteTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/forwarding-table?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "route_type,network,interface,next_hop,admin_distance,lr_component_id,lr_component_type\nNSX_INTERNAL,0.0.0.0/0,/infra/tier-0s/t0/locale-services/default/interfaces/public1,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nNSX_INTERNAL,100.64.1.0/31,,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nNSX_INTERNAL,100.64.1.1/32,,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,169.0.0.0/28,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,172.16.10.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,1l72.16.20.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,172.16.30.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\n"
}
},
"/global-infra/sites/{site-id}/settings/firewall/security": {
"get": {
"tags": [
"Federation",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Distributed Firewall Settings"
],
"summary": "Get global distributed firewall configuration for the specified site",
"description": "Get global distributed firewall configuration for the specified site.",
"operationId": "GlobalInfraGetGlobalDfwConfigurationForSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "Site ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalDfwConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/global-manager/api/v1/global-infra/sites/london/settings/firewall/security\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"GlobalDfwConfiguration\",\n \"id\": \"security\",\n \"display_name\": \"security\",\n \"path\": \"/global-infra/sites/london/settings/firewall/security\",\n \"relative_path\": \"security\",\n \"marked_for_delete\": false,\n \"enable_firewall\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1554274751846,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1554274751846,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/lb-service-usage-summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Usage",
"Usage"
],
"summary": "Read load balancer service usage summary",
"description": "API is used to retrieve the load balancer usage summary for\nall load balancer services.\nIf the parameter ?include_usages=true exists, the property service-usages\nis included in the response. By default, service-usages is not included\nin the response.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "GetLBServiceUsageSummary",
"parameters": [
{
"name": "include_usages",
"in": "query",
"description": "Whether to include usages",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBServiceUsageSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyLBStatistics"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Groups"
],
"summary": "List Groups for a domain",
"description": "List Groups for a domain. Groups can be filtered using member_types query parameter,\nwhich returns the groups that contains the specified member types. Multiple member types\ncan be provided as comma separated values. The API also return groups having member\ntype that are subset of provided member_types.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListGroupForDomain",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "member_types",
"in": "query",
"description": "Comma Separated Member types",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/groups\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Group\",\n \"description\": \"web group\",\n \"id\": \"webgroup\",\n \"display_name\": \"web group\",\n \"path\": \"/infra/domains/vmc/groups/webgroup\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"webgroup\",\n \"expression\": [\n {\n \"resource_type\": \"Condition\",\n \"member_type\": \"VirtualMachine\",\n \"value\": \"webvm\",\n \"key\": \"Tag\",\n \"operator\": \"EQUALS\",\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517308749250,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517308749250,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/context-profiles/attributes": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "List Policy Context Profile supported attributes and sub-attributes",
"description": "Returns supported attribute and sub-attributes for specified\nattribute key with their supported values, if provided in query/request\nparameter, else will fetch all supported attributes and sub-attributes for\nall supported attribute keys.\nAlternatively, to get a list of supported attributes and sub-attributes fire the following REST API\nGET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes\n",
"operationId": "ListProfileSupportedAttributes",
"parameters": [
{
"name": "attribute_key",
"in": "query",
"description": "Fetch attributes and sub-attributes for the given attribute key",
"schema": {
"type": "string"
}
},
{
"name": "attribute_source",
"in": "query",
"description": "Source of the attribute, System Defined or custom",
"schema": {
"type": "string",
"default": "SYSTEM",
"enum": [
"ALL",
"CUSTOM",
"SYSTEM"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\": [\n \"SSL\"\n ],\n \"datatype\":\"STRING\",\n \"description\":\"SSL (Secure Sockets Layer) is a cryptographic protocol that provides security over the Internet.\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V10\",\n \"TLS_V11\",\n \"TLS_V12\",\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\",\n \"SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA\",\n ]\n \"datatype\":\"STRING\"\n }\n ],\n },\n {\n \"key\":\"DOMAIN_NAME\",\n \"value\": [\n \"*.office365.com\"\n ],\n \"datatype\":\"STRING\",\n \"description\":\"Office 365 url\"\n }\n ]\n }\n ]\n}\n"
}
},
"/cluster/restore?action=retry": {
"post": {
"tags": [
"System Administration",
"Lifecycle Management",
"Backup Restore Management",
"Restore"
],
"summary": "Retry any failed restore operation",
"description": "Retry any currently in-progress, failed restore operation. Only the last\nstep of the multi-step restore operation would have failed,and only that\nstep is retried. This operation is only valid when a\nGET cluster/restore/status returns a status with value FAILED. Otherwise,\na 409 response is returned.\n",
"operationId": "RetryClusterRestore",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterRestoreStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterRestoreStatus"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/cluster/restore?action=retry\n",
"x-vmw-nsx-module": "ClusterRestore",
"x-vmw-nsx-example-response": "{\n \"id\": \"86e81e05-bc3c-4216-a0a2-3bf46ece68a3\",\n \"backup_timestamp\": 1435298084391,\n \"restore_start_time\": 1483463180963,\n \"restore_end_time\": null,\n \"step\": {\n \"step_number\": 4,\n \"value\": \"SFTP_COPY_START\",\n \"description\": \"Starting sftp copy\"\n \"status\": {\n \"value\": \"RUNNING\",\n \"description\": \"Sftp copy starting\"\n }\n },\n \"status\": {\n \"value\": \"RUNNING\",\n \"description\": \"The operation is currently running\"\n }\n \"total_steps\": 11,\n \"endpoints\": [\n {\n action: POST, href: '/cluster/restore?action=suspend', rel: \"self\"\n },\n {\n action: POST, href: '/cluster/restore?action=cancel', rel: \"self\"\n }\n ],\n \"instructions\": []\n}\n"
}
},
"/infra/realized-state/system-virtual-machines": {
"get": {
"tags": [
"Policy",
"Inventory",
"Virtual Machines"
],
"summary": "Lists all the system virtual machines.",
"description": "Lists all the system virtual machines (example -Partner and Edge VMs etc)\n",
"operationId": "ListSystemVMs",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "query",
"in": "query",
"description": "Search query",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/realized-state/system-virtual-machines\n",
"x-vmw-nsx-module": "PolicyRealizedState",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"host_id\": \"f8aeaa94-3e3b-48dd-bbd4-595676b87aaa\",\n \"source\": {\n \"target_id\": \"f8aeaa94-3e3b-48dd-bbd4-595676b87aaa\",\n \"target_display_name\": \"TN-1\",\n \"target_type\": \"HostNode\",\n \"is_valid\": true\n },\n \"external_id\": \"6ab92268-3ae3-443f-b073-c8020fe783a5\",\n \"power_state\": \"VM_RUNNING\",\n \"local_id_on_host\": \"2\",\n \"compute_ids\": [\n \"moIdOnHost:2\",\n \"hostLocalId:2\",\n \"locationId:564dc3dc-7e69-5e4f-102a-c29b5dddba49\",\n \"instanceUuid:6ab92268-3ae3-443f-b073-c8020fe783a5\",\n \"externalId:6ab92268-3ae3-443f-b073-c8020fe783a5\",\n \"biosUuid:564dc3dc-7e69-5e4f-102a-c29b5dddba49\"\n ],\n \"type\": \"INTELLIGENCE\",\n \"resource_type\": \"VirtualMachine\",\n \"display_name\": \"vsphere_vm_2\",\n \"_last_sync_time\": 1589890824000\n }\n]\n }\n"
}
},
"/eula/content": {
"get": {
"tags": [
"System Administration",
"Settings",
"Licenses"
],
"summary": "Return the content of end user license agreement\n",
"description": "Return the content of end user license agreement in the specified format.\nBy default, it's pure string without line break\n",
"operationId": "GetEULAContent",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "value_format",
"in": "query",
"description": "End User License Agreement content output format",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EULAContent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/eula/content?value_format=html\n",
"x-vmw-nsx-module": "EULA",
"x-vmw-nsx-example-response": "{\n \"content\": \"End User License Agreement\"\n}\n"
}
},
"/global-infra/sha/plugin-status/{node-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Show the plugins status on given node.",
"description": "Show all the installed system health plugins on given node\n",
"operationId": "GlobalInfraShowPluginStatusOnNode",
"parameters": [
{
"name": "node-id",
"in": "path",
"description": "The TN node id.\n",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PerNodeShaPluginStatusListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sha/plugin-status/a257b981-1a1c-4b95-b16c-8646e85ce8f0\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"result_count\":1,\n \"results\": [\n {\n \"plugin_path\": \"/infra/sha/dynamic-plugins/monitor-plugin\",\n \"status\": \"enabled\",\n \"profile\": \"{ENABLED: true, CHECK_INTERVAL: 20}\",\n \"detail\": \"\",\n \"node_path\": \"/infra/sites/default/enforcement-points/default/host-transport-nodes/a257b981-1a1c-4b95-b16c-8646e85ce8f0\"\n }\n ]\n}"
}
},
"/infra/segments/{segment-id}/ports/{port-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "Get infra segment port by ID",
"description": "Get detail information on an infra segment port by giving ID.\n",
"operationId": "GetInfraSegmentPort",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPort"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web-tier/ports/\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentPort\",\n \"id\": \"port1\",\n \"display_name\": \"port1\",\n \"path\": \"/infra/segments/web-tier/ports/port1\",\n \"relative_path\": \"port1\",\n \"parent_path\": \"/infra/segments/web-tier\",\n \"address_bindings\": [\n {\n \"ip_address\":\"1.1.1.1\",\n \"mac_address\":\"aa:bb:cc:dd:ee:ff\"\n \"vlan_id\": 0\n },\n {\n \"ip_address\":\"1.1.1.2\",\n \"mac_address\":\"aa:bb:cc:dd:ee:f1\"\n \"vlan_id\": 0\n }\n ],\n \"tags\": [\n {\n \"tag\":\"port-1 tag 1 from Policy\",\n \"scope\":\"Policy\"\n }\n ],\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544503100539,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544503100539,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "Create or update an infra segment port",
"description": "Create an infra segment port if it does not exist based on the IDs, or update existing port\ninformation by replacing the port object already exists.\n",
"operationId": "CreateOrReplaceInfraSegmentPort",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPort"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPort"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/segments/web-tier/ports/port1\n {\n \"address_bindings\": [\n { \"ip_address\":\"1.1.1.1\", \"mac_address\":\"aa:bb:cc:dd:ee:ff\" },\n { \"ip_address\":\"1.1.1.2\", \"mac_address\":\"aa:bb:cc:dd:ee:f1\" }\n ],\n \"tags\": [\n {\"tag\":\"port-1 tag 1 from Policy\",\"scope\":\"Policy\"}\n ]\n }\n {\n \"attachment\": {\n \"allocate_addresses\": \"Dhcp\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\",\n \"routing_table\": [\"-net 201.10.0.0 netmask 255.255.0.0 gw 192.168.1.1\", \"-net 0.0.0.0 netmask 0.0.0.0 gw 172.16.1.1\"]\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"attachment\": {\n \"allocate_addresses\": \"Both\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\",\n \"routing_table\": [\"-net 201.10.0.0 netmask 255.255.0.0 gw 192.168.1.1\", \"-net 0.0.0.0 netmask 0.0.0.0 gw 172.16.1.1\"]\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"address_bindings\": [\n {\n \"mac_address\": \"24:6E:96:62:B1:A6\"\n }\n ],\n \"attachment\": {\n \"allocate_addresses\": \"IpPool\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\"\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"address_bindings\": [\n {\n \"ip_address\": \"192.1.1.201/24\"\n }\n ],\n \"attachment\": {\n \"allocate_addresses\": \"MacPool\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\"\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"address_bindings\": [\n {\n \"ip_address\": \"192.1.1.201/24\",\n \"mac_address\": \"24:6E:96:62:B1:A6\"\n }\n ],\n \"attachment\": {\n \"allocate_addresses\": \"NONE\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\"\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentPort\",\n \"id\": \"port1\",\n \"display_name\": \"port1\",\n \"path\": \"/infra/segments/web-tier/ports/port1\",\n \"relative_path\": \"port1\",\n \"parent_path\": \"/infra/segments/web-tier\",\n \"address_bindings\": [\n {\n \"ip_address\":\"1.1.1.1\",\n \"mac_address\":\"aa:bb:cc:dd:ee:ff\"\n },\n {\n \"ip_address\":\"1.1.1.2\",\n \"mac_address\":\"aa:bb:cc:dd:ee:f1\"\n }\n ],\n \"tags\": [\n {\n \"tag\":\"port-1 tag 1 from Policy\",\n \"scope\":\"Policy\"\n }\n ],\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544503100539,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544503100539,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "SegmentPort"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "Delete an infra segment port",
"description": "Delete an infra segment port by giving ID. Please note that this operation will not delete\nthe segment port from vCenter Server if the port was connected to a Virtual Machine.\nPlease connect Virtual Machine to another network for the segment port to be deleted\nfrom vCenter Server.\n",
"operationId": "DeleteInfraSegmentPort",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/segments/web-tier/ports/port1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "Patch an infra segment port",
"description": "Create an infra segment port if it does not exist based on the IDs, or update existing port\ninformation by replacing the port object fields which presents in the request body.\n",
"operationId": "PatchInfraSegmentPort",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPort"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/segments/web-tier/ports/port1\n {\n \"address_bindings\": [\n { \"ip_address\":\"1.1.1.1\", \"mac_address\":\"aa:bb:cc:dd:ee:ff\" },\n { \"ip_address\":\"1.1.1.2\", \"mac_address\":\"aa:bb:cc:dd:ee:f1\" }\n ],\n \"tags\": [\n {\"tag\":\"port-1 tag 1 from Policy\",\"scope\":\"Policy\"}\n ]\n }\n {\n \"attachment\": {\n \"allocate_addresses\": \"Dhcp\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\",\n \"routing_table\": [\"-net 201.10.0.0 netmask 255.255.0.0 gw 192.168.1.1\", \"-net 0.0.0.0 netmask 0.0.0.0 gw 172.16.1.1\"]\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"attachment\": {\n \"allocate_addresses\": \"Both\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\",\n \"routing_table\": [\"-net 201.10.0.0 netmask 255.255.0.0 gw 192.168.1.1\", \"-net 0.0.0.0 netmask 0.0.0.0 gw 172.16.1.1\"]\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"address_bindings\": [\n {\n \"mac_address\": \"24:6E:96:62:B1:A6\"\n }\n ],\n \"attachment\": {\n \"allocate_addresses\": \"IpPool\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\"\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"address_bindings\": [\n {\n \"ip_address\": \"192.1.1.201/24\"\n }\n ],\n \"attachment\": {\n \"allocate_addresses\": \"MacPool\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\"\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n {\n \"address_bindings\": [\n {\n \"ip_address\": \"192.1.1.201/24\",\n \"mac_address\": \"24:6E:96:62:B1:A6\"\n }\n ],\n \"attachment\": {\n \"allocate_addresses\": \"NONE\",\n \"app_id\": \"BM1_APP1\",\n \"bms_interface_config\": {\n \"app_intf_name\": \"bm1\"\n },\n \"context_id\": \"2b883ab0-6b82-4c38-bdd2-e929f15e8a4d\",\n \"id\": \"b9e54d63-2437-4e53-889f-66a83822c0c1\",\n \"type\": \"STATIC\"\n }\n }\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "SegmentPort"
}
},
"/infra/csrs/{csr-id}?action=create": {
"post": {
"tags": [
"Policy",
"Infra",
"Certificates",
"CSR"
],
"summary": "Generate a New Certificate Signing Request",
"description": "Creates a new certificate signing request (CSR). A CSR is encrypted text that\ncontains information about your organization (organization name, country,\nand so on) and your Web server's public key, which is a public certificate\nthe is generated on the server that can be used to forward this request to a\ncertificate authority (CA). A private key is also usually created at the\nsame time as the CSR.\n",
"operationId": "GenerateTlsCsr",
"parameters": [
{
"name": "csr-id",
"in": "path",
"description": "ID of CSR to create",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCsr"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCsr"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/csrs/example-csr-id?action=create\n{\n \"subject\":\n {\n \"attributes\":\n [\n {\"key\":\"CN\",\"value\":\"Jane\"},\n {\"key\":\"O\",\"value\":\"VMware\"},\n {\"key\":\"OU\",\"value\":\"NSBU\"},\n {\"key\":\"C\",\"value\":\"US\"},\n {\"key\":\"ST\",\"value\":\"CA\"},\n {\"key\":\"L\",\"value\":\"PA\"}\n ]\n },\n \"key_size\": \"2048\",\n \"algorithm\": \"RSA\",\n \"is_ca\": false\n}\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"TlsCsr\",\n \"id\": \"example-csr-id\",\n \"display_name\": \"example-csr-id\",\n \"path\": \"/infra/csrs/example-csr-id\",\n \"parent_path\": \"/infra/csrs\",\n \"relative_path\": \"example-csr-id\",\n \"pem_encoded\": \"-----BEGIN CERTIFICATE REQUEST----------END CERTIFICATE REQUEST-----\\n\",\n \"key_size\": 2048,\n \"subject\": {\n \"attributes\": [\n {\n \"value\": \"Jane\",\n \"key\": \"CN\"\n },\n {\n \"value\": \"VMware\",\n \"key\": \"O\"\n },\n {\n \"value\": \"NSBU\",\n \"key\": \"OU\"\n },\n {\n \"value\": \"US\",\n \"key\": \"C\"\n },\n {\n \"value\": \"CA\",\n \"key\": \"ST\"\n },\n {\n \"value\": \"PA\",\n \"key\": \"L\"\n }\n ]\n },\n \"algorithm\": \"RSA\",\n \"is_ca\": false,\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516338671237,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516338671237,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "TlsCsr"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "List IDS Custom Signatures",
"description": "List IDS Custom Signatures.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIdsCustomSignatures",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "Custom signatures to be returned",
"schema": {
"type": "string",
"enum": [
"PREVIEW_CUSTOM_SIGNATURES",
"CUSTOM_SIGNATURES"
]
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsCustomSignatureListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1/custom-signatures?include=PREVIEW_CUSTOM_SIGNATURES\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001061397\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001061397\",\n \"relative_path\": \"1001061397\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - (Initial Access) Detect CVE-2014-6332\",\n \"class_type\": \"attempted-user\",\n \"severity\": \"HIGH\",\n \"signature_revision\": \"3565\",\n \"signature_id\": \"1001061397\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"9.3\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"cves\": [\n \"2014-6332\"\n ],\n \"flow\": \"established,to_server\",\n \"action\": \"reject\",\n \"enable\": true,\n \"impact\": \"52\",\n \"risk_score\": \"75\",\n \"confidence\": \"70\",\n \"mitre_attack\": [\n {\n \"tactic_url\": \"https://attack.mitre.org/tactics/TA0001/\",\n \"tactic_name\": \"Initial Access\",\n \"technique_name\": \"Drive-by Compromise\",\n \"technique_url\": \"https://attack.mitre.org/techniques/T1189/\"\n }\n ],\n \"signature\": \"reject http $HOME_NET any -> $EXTERNAL_NET any (msg:\\\"NSX - (Initial Access) Detect CVE-2014-6332\\\"; flow:established,to_server; target:src_ip; content:\\\"GET\\\"; nocase; http_method; content:\\\"?MTIzNDU2\\\"; http_uri; pcre:\\\"/\\/\\\\?MTIzNDU2[A-Za-z0-9+\\/=]*&d=[a-z0-9]{32} HTTP/\\\"; flowbits:set,LL.verifier_http_successful; flowbits:set,LL.verifier_http_failed; flowbits:set,LL.verifier_http_blocked; threshold: type limit, track by_src, seconds 180, count 1; metadata:ll_expected_verifier default, flip_endpoints False, server_side False, threat_class_name drive-by, threat_name CVE-2014-6332, ids_mode REAL, blacklist_mode DISABLED, exploited None, confidence 70, severity 75, detector_id 61397, signature_severity High; reference:url,www.lastline.com; classtype:attempted-user; sid:1061397; rev:3565; priority:2;)\",\n \"original_signature_id\": \"1061397\",\n \"validation_status\": \"WARNING\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995216,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995216,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001060933\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001060933\",\n \"relative_path\": \"1001060933\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - Detect Zeus activity\",\n \"class_type\": \"trojan-activity\",\n \"severity\": \"CRITICAL\",\n \"signature_revision\": \"3007\",\n \"signature_id\": \"1001060933\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"0.0\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"flow\": \"established,to_client\",\n \"action\": \"reject\",\n \"enable\": false,\n \"impact\": \"80\",\n \"risk_score\": \"100\",\n \"confidence\": \"80\",\n \"signature\": \"reject http $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - Detect Zeus activity\\\"; flow:established,to_client; target:dest_ip; content:\\\"|00 00 00 00 8D|L|C8 15 F6|dps|C7|VQ5|03|C|DD|&\\\"; pcre:\\\"/^\\\\x00\\\\x00\\\\x00\\\\x00\\\\x8DL\\\\xC8\\\\x15\\\\xF6dps\\\\xC7VQ5\\\\x03C\\\\xDD&/Q\\\"; threshold: type limit, track by_dst, seconds 180, count 1; metadata:ll_verifier_outcome successful, flip_endpoints True, server_side False, threat_class_name command&control, threat_name Zeus Variant, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 80, severity 100, detector_id 60921, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060921; rev:3007; priority:1;)\",\n \"original_signature_id\": \"1060933\",\n \"validation_status\": \"INVALID\",\n \"validation_message\": \"test message\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995213,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995213,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001060921\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001060921\",\n \"relative_path\": \"1001060921\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - Detect Zeus activity\",\n \"class_type\": \"trojan-activity\",\n \"severity\": \"CRITICAL\",\n \"signature_revision\": \"3007\",\n \"signature_id\": \"1001060921\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"0.0\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"flow\": \"established,to_client\",\n \"action\": \"reject\",\n \"enable\": true,\n \"impact\": \"80\",\n \"risk_score\": \"100\",\n \"confidence\": \"80\",\n \"signature\": \"reject http $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - Detect Zeus activity\\\"; flow:established,to_client; target:dest_ip; content:\\\"|00 00 00 00 8D|L|C8 15 F6|dps|C7|VQ5|03|C|DD|&\\\"; pcre:\\\"/^\\\\x00\\\\x00\\\\x00\\\\x00\\\\x8DL\\\\xC8\\\\x15\\\\xF6dps\\\\xC7VQ5\\\\x03C\\\\xDD&/Q\\\"; threshold: type limit, track by_dst, seconds 180, count 1; metadata:ll_verifier_outcome successful, flip_endpoints True, server_side False, threat_class_name command&control, threat_name Zeus Variant, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 80, severity 100, detector_id 60921, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060921; rev:3007; priority:1;)\",\n \"original_signature_id\": \"1060921\",\n \"validation_status\": \"VALID\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995211,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995211,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"IdsCustomSignaturePreview\",\n \"id\": \"1001061571\",\n \"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures-preview/1001061571\",\n \"relative_path\": \"1001061571\",\n \"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"name\": \"NSX - (Initial Access) Detect transfer of the Metasploit payload windows/x64/vncinject/reverse_tcp_uuid\",\n \"class_type\": \"attempted-user\",\n \"severity\": \"HIGH\",\n \"signature_revision\": \"1\",\n \"signature_id\": \"1001061571\",\n \"categories\": [\n \"APPLICATION\"\n ],\n \"cvssv3\": \"0.0\",\n \"cvssv2\": \"0.0\",\n \"attack_target\": \"Client_Endpoint\",\n \"product_affected\": \"NONE\",\n \"flow\": \"established,to_client\",\n \"action\": \"reject\",\n \"enable\": true,\n \"impact\": \"52\",\n \"risk_score\": \"75\",\n \"confidence\": \"70\",\n \"mitre_attack\": [\n {\n \"tactic_url\": \"https://attack.mitre.org/tactics/TA0001/\",\n \"tactic_name\": \"Initial Access\",\n \"technique_name\": \"Exploit Public-Facing Application\",\n \"technique_url\": \"https://attack.mitre.org/techniques/T1190/\"\n }\n ],\n \"signature\": \"reject tcp $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - (Initial Access) Detect transfer of the Metasploit payload windows/x64/vncinject/reverse_tcp_uuid\\\"; flow:established,to_client; target:dest_ip; content:\\\"|FC|H|83 E4 F0 E8 CC 00 00 00|AQAPR\\\"; content:\\\"QVH1|D2|eH|8B|R|60|H|8B|R|18|H\\\"; content:\\\"|8B|R H|8B|rPH|0F B7|JJM1|C9|\\\"; content:\\\"H1|C0 AC| $EXTERNAL_NET any (msg:\\\"NSX - Detect Fareit\\\"; flow:established,to_server; target:src_ip; content:\\\"POST /\\\"; content:\\\"news.php\\\"; content:\\\"HTTP/\\\"; content:\\\"Host|3A|\\\"; content:\\\"Accept|3A| |2A|/|2A|\\\"; content:\\\"Connection|3A| close\\\"; content:\\\"Content-Encoding|3A| binary\\\"; content:!\\\"Referer|3A|\\\"; pcre:\\\"/\\\\xFF/P\\\"; flowbits:set,LL.verifier_http_successful; flowbits:set,LL.verifier_http_failed; flowbits:set,LL.verifier_http_blocked; threshold: type limit, track by_src, seconds 180, count 1; metadata:ll_expected_verifier default, flip_endpoints False, server_side False, threat_class_name command&control, threat_name Fareit, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 85, severity 100, detector_id 60759, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060759; rev:2778; priority:1;)\",\n \"original_signature_id\": \"1060759\",\n \"validation_status\": \"VALID\",\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_create_time\": 1717741995213,\n \"_create_user\": \"admin\",\n \"_last_modified_time\": 1717741995213,\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0\n }\n],\n\"result_count\": 5,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/troubleshoot": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"BGP"
],
"summary": "Read BGP troubleshoot config",
"description": "Read BGP troubleshoot config",
"operationId": "ReadBgpTroubleshootConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BgpTroubleshootConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/bgp/troubleshoot\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"bgp_session_diagnostics\": true,\n \"system_diagnostics\": true,\n \"bfd_control_pkt_diagnostics\": true,\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"BGP"
],
"summary": "Create or update a BGP troubleshoot config",
"description": "If BGP troubleshoot config is not present in BGP configuration, create a new BGP\ntroubleshoot config with default value. If it already exists, update the BGP\ntroubleshoot config with this object.\n",
"operationId": "CreateOrReplaceBgpTroubleshootConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BgpTroubleshootConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BgpTroubleshootConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/bgp/troubleshoot\n{\n \"bgp_session_diagnostics\": true,\n \"system_diagnostics\": true,\n \"bfd_control_pkt_diagnostics\": true,\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"bgp_session_diagnostics\": true,\n \"system_diagnostics\": true,\n \"bfd_control_pkt_diagnostics\": true,\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "BgpTroubleshootConfig"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"BGP"
],
"summary": "Create or update a BGP troubleshoot config",
"description": "If BGP troubleshoot config is not present in BGP configuration, create a new BGP\ntroubleshoot config with default value. If it already exists, update the BGP\ntroubleshoot config with this object.\n",
"operationId": "PatchBgpTroubleshootConfig",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BgpTroubleshootConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/bgp/troubleshoot\n{\n \"bgp_session_diagnostics\": true,\n \"system_diagnostics\": true,\n \"bfd_control_pkt_diagnostics\": true,\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "BgpTroubleshootConfig"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments (Fixed)"
],
"summary": "Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.",
"description": "Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.\nThis API call does not return flexible segments (identified as /policy/api/v1/infra/segments/) connected to the Tier-1.\nTo return all segments connected as a downlink to a Tier-1 one possibility is to use the search API with: https://{{nsx-mgr}}/policy/api/v1/search?query=resource_type:Segment%20AND%20connectivity_path:“/infra/tier-1s/\nExtended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the\n\"l2_extension\" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path\ninstead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.\nAlso note that l2vpn path included in the error messages returned from validation may include the new VPN path\ninstead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.\n",
"operationId": "GlobalInfraListSegments",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "segment_type",
"in": "query",
"description": "Segment type",
"schema": {
"type": "string",
"enum": [
"DVPortgroup",
"ALL"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/segments\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Segment\",\n \"id\": \"web-tier\",\n \"display_name\": \"web-tier\",\n \"path\": \"/infra/tier-1s/cgw/segments/web-tier\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [\n \"40.1.2.0/24\"\n ]\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668961954,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668961954,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ipsec-vpn-dpd-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"DPD Profiles"
],
"summary": "List DPD profiles",
"description": "Get paginated list of all DPD Profiles.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIPSecVpnDpdProfiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnDpdProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-dpd-profiles",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n \"resource_type\" : \"IPSecVpnDpdProfile\",\n \"path\": \"/infra/ipsec-vpn-dpd-profiles/aws-dpd-profile\",\n \"enabled\" : true,\n \"dpd_probe_interval\" : 90,\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/host-transport-nodes/{host-transport-node-id}/statistics/monitor": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Nodes"
],
"summary": "Get the counter values for cached datapath statistics.",
"description": "Get the counter values for cached datapath statistics. Support multiple types in one query. \nQuery types should be declared inside query parameters. By default the query type is packet_stats.\n",
"operationId": "GetObservabilityMonitorStatics",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "host-transport-node-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "type",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObservabilityCounterMonitorQueryResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default-site/enforcement-points/default/host-transport-nodes/aee945d2-06a4-47d5-adb2-dd386053f77c/statistics/monitor?type=packet_stats,platform_cpu_usage_stats,fast_path_sys_stats,platform_packet_stats\n",
"x-vmw-nsx-module": "ObservabilityCounters",
"x-vmw-nsx-example-response": "{\n \"fast_path_sys_stats\": {\n \"host_enhanced_fastpath\": {\n \"num_flow_tables\": 0,\n \"flow_table_size\": 65536,\n \"num_flows\": 0,\n \"num_flows_created\": 0,\n \"hits\": 0,\n \"miss\": 0,\n \"slowpath\": 0,\n \"insertion_errors\": 0,\n \"flow_table_occupancy_95_pct\": 0,\n \"flow_table_occupancy_90_pct\": 0,\n \"flow_table_occupancy_75_pct\": 0,\n \"flow_table_occupancy_50_pct\": 0,\n \"flow_table_occupancy_25_pct\": 0,\n \"flow_table_occupancy_0_pct\": 0\n },\n \"host_standard_fastpath\": {\n \"num_flow_tables\": 1,\n \"flow_table_size\": 65536,\n \"num_flows\": 0,\n \"num_flows_created\": 0,\n \"hits\": 0,\n \"miss\": 0,\n \"slowpath\": 0,\n \"insertion_errors\": 0,\n \"flow_table_occupancy_95_pct\": 0,\n \"flow_table_occupancy_90_pct\": 0,\n \"flow_table_occupancy_75_pct\": 0,\n \"flow_table_occupancy_50_pct\": 0,\n \"flow_table_occupancy_25_pct\": 0,\n \"flow_table_occupancy_0_pct\": 1\n },\n \"last_update_timestamp\": 1706048050\n },\n \"packet_stats\": {\n \"number_of_vnics\": 6,\n \"local_workloads_transmitted_received_packets\": {\n \"vnic_txpps\": 18.0,\n \"vnic_rxpps\": 18917.0,\n \"vnic_txmbps\": 0.0,\n \"vnic_rxmbps\": 9.0,\n \"vnic_txeps\": 0.0,\n \"vnic_rxeps\": 0.0\n },\n \"number_of_pnics\": 2,\n \"pnics_transmitted_received_packets\": {\n \"pnic_txpps\": 178.0,\n \"pnic_rxpps\": 3988.0,\n \"pnic_txmbps\": 1.0,\n \"pnic_rxmbps\": 3.0,\n \"pnic_txeps\": 0.0,\n \"pnic_rxeps\": 0.0\n },\n \"local_workloads_transmitted_received_broadcast_packets\": {\n \"broadcast_txpps\": 0.0,\n \"broadcast_rxpps\": 0.0\n },\n \"local_workloads_transmitted_received_multicast_packets\": {\n \"multicast_txpps\": 0.0,\n \"multicast_rxpps\": 0.0\n },\n \"datapath_system_error_packet_drops\": 0,\n \"datapath_total_packet_drops_pps\": 0.0,\n \"datapath_packet_drops\": {\n \"hostswitch_received_forged_mac_packet_drops\": 0,\n \"hostswitch_network_mismatch_packet_drops\": 0,\n \"overlay_received_packet_drops\": 0,\n \"overlay_transmitted_packet_drops\": 0,\n \"overlay_uplink_received_packet_drops\": 0,\n \"overlay_uplink_transmitted_packet_drops\": 0,\n \"l3_reverse_path_forwarding_packet_drops\": 0,\n \"l3_no_route_packet_drops\": 0,\n \"l3_neighbor_unreachable_packet_drops\": 0,\n \"l3_hop_limit_packet_drops\": 0,\n \"broadcast_rate_limiting_packet_drops\": 0,\n \"workload_dhcp_not_allowed_packet_drops\": 0,\n \"spoof_guard_packet_drops\": 0,\n \"workload_ipv6_ra_guard_packet_drops\": 0,\n \"workload_bpdu_filter_packet_drops\": 0,\n \"firewall_total_packet_drops\": 0,\n \"firewall_packet_rejects\": 0,\n \"firewall_malformed_packet_drops\": 0,\n \"firewall_internal_error_packet_drops\": 0,\n \"firewall_state_table_full_packet_drops\": 0,\n \"firewall_rule_received_packet_drops\": 0,\n \"firewall_rule_transmitted_packet_drops\": 0,\n \"firewall_state_check_packet_drops\": 0,\n \"firewall_flood_limit_packet_drops\": 0,\n \"fastpath_packet_drops\": 0,\n \"packet_parsing_error_drops\": 0\n },\n \"unicast_packet_flooding\": {\n \"hostswitch_unknown_l2_unicast_to_uplink_txpps\": 0.0,\n \"hostswitch_unknown_l2_unicast_from_uplink_rxpps\": 0.0,\n \"overlay_flooded_l2_unicast_to_uplink_txpps\": 0.0\n },\n \"packet_processing_efficiency_watch\": {\n \"overlay_unsuccessful_control_plane_assisted_neighbor_resolution_rxpps\": 0.0,\n \"overlay_unsuccessful_mac_learning_due_to_table_full_rxpps\": 0.0,\n \"overlay_unsuccessful_mac_learning_due_to_unknown_tunnel_endpoint_rxpps\": 0.0,\n \"fastpath_flow_hit_pps\": 0.0,\n \"fastpath_flow_miss_pps\": 0.0,\n \"fastpath_slowpath_only_pps\": 0.0\n },\n \"last_update_timestamp\": 1706048050\n },\n \"platform_cpu_usage_stats\": {\n \"host_net_thread_all\": {\n \"num_threads\": 19,\n \"min_cpu\": 0.0,\n \"max_cpu\": 0.61,\n \"total_cpu\": 0.7,\n \"hist_99_pct\": 0,\n \"hist_97_pct\": 0,\n \"hist_95_pct\": 0,\n \"hist_90_pct\": 0,\n \"hist_85_pct\": 0,\n \"hist_80_pct\": 0,\n \"hist_70_pct\": 0,\n \"hist_50_pct\": 0,\n \"hist_25_pct\": 0,\n \"hist_0_pct\": 19\n },\n \"host_pcpu\": {\n \"total_cpu\": 35.6,\n \"hist_95_pct\": 0,\n \"hist_90_pct\": 0,\n \"hist_85_pct\": 0,\n \"hist_75_pct\": 0,\n \"hist_50_pct\": 0,\n \"hist_0_pct\": 4\n },\n \"host_vcpu\": {\n \"total_cpu\": 12.34,\n \"hist_95_pct\": 0,\n \"hist_90_pct\": 0,\n \"hist_85_pct\": 0,\n \"hist_75_pct\": 0,\n \"hist_50_pct\": 0,\n \"hist_0_pct\": 7\n },\n \"last_update_timestamp\": 1706048050\n },\n \"platform_packet_stats\": {\n \"host_vnic\": {\n \"num_vnics\": 6,\n \"txpps\": 18.0,\n \"txmbps\": 0.0,\n \"txeps\": 0.0,\n \"rxpps\": 18917.0,\n \"rxmbps\": 9.0,\n \"rxeps\": 0.0\n },\n \"host_uplink\": {\n \"num_pnics\": 2,\n \"txpps\": 178.0,\n \"txmbps\": 1.0,\n \"txeps\": 0.0,\n \"rxpps\": 3988.0,\n \"rxmbps\": 3.0,\n \"rxeps\": 0.0,\n \"rx_missed\": 0,\n \"rx_error_total\": 0\n },\n \"last_update_timestamp\": 1706048050\n },\n \"fast_path_lcore_usage_stats\": {\n \"lcore_rank_01_lcore_id\": 0,\n \"lcore_rank_01_lcore_usage\": 0.0,\n \"lcore_rank_02_lcore_id\": 0,\n \"lcore_rank_02_lcore_usage\": 0.0,\n \"lcore_rank_03_lcore_id\": 0,\n \"lcore_rank_03_lcore_usage\": 0.0,\n \"lcore_rank_04_lcore_id\": 0,\n \"lcore_rank_04_lcore_usage\": 0.0,\n \"lcore_rank_05_lcore_id\": 0,\n \"lcore_rank_05_lcore_usage\": 0.0,\n \"lcore_rank_06_lcore_id\": 0,\n \"lcore_rank_06_lcore_usage\": 0.0,\n \"lcore_rank_07_lcore_id\": 0,\n \"lcore_rank_07_lcore_usage\": 0.0,\n \"lcore_rank_08_lcore_id\": 0,\n \"lcore_rank_08_lcore_usage\": 0.0,\n \"lcore_rank_09_lcore_id\": 0,\n \"lcore_rank_09_lcore_usage\": 0.0,\n \"lcore_rank_10_lcore_id\": 0,\n \"lcore_rank_10_lcore_usage\": 0.0,\n \"lcore_rank_11_lcore_id\": 0,\n \"lcore_rank_11_lcore_usage\": 0.0,\n \"lcore_rank_12_lcore_id\": 0,\n \"lcore_rank_12_lcore_usage\": 0.0,\n \"lcore_rank_13_lcore_id\": 0,\n \"lcore_rank_13_lcore_usage\": 0.0,\n \"lcore_rank_14_lcore_id\": 0,\n \"lcore_rank_14_lcore_usage\": 0.0,\n \"lcore_rank_15_lcore_id\": 0,\n \"lcore_rank_15_lcore_usage\": 0.0,\n \"lcore_rank_16_lcore_id\": 0,\n \"lcore_rank_16_lcore_usage\": 0.0,\n \"number_of_lcores\": 16,\n \"last_update_timestamp\": 1706048050\n }\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/gateway-interface-statistics/summary": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"Interfaces",
"Statistics"
],
"summary": "Get statistics for downlink router port",
"description": "Get statistics for downlink router port\n",
"operationId": "GetVpcSubnetGatewayInterfaceStatisticsSummary",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatisticsSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/subnets/subnet-1/gateway-interface-statistics/summary\n",
"x-vmw-nsx-module": "PolicyVpcSubnetStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_policy_path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/subnets/subnet-1\",\n \"last_update_timestamp\": 1591854157020,\n \"rx\": {\n \"total_bytes\": 314886932,\n \"total_packets\": 678919,\n \"dropped_packets\": 151381\n },\n \"tx\": {\n \"total_bytes\": 75554376,\n \"total_packets\": 1130225,\n \"dropped_packets\": 151381\n },\n \"logical_router_port_id\": \"cbac60fb-841f-4d29-951b-500f527bda34\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/effective-resources": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Tags"
],
"summary": "List all objects assigned with matching scope and tag values",
"description": "Paginated list of all objects assigned with matching scope and tag values. Objects\nare represented in form of resource reference. Sort option is available only on\ntarget_type and target_display_name properties.\n",
"operationId": "ListTaggedObjectsForVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "filter_by",
"in": "query",
"description": "Comma-separated list of field names to filter tagged objects.",
"schema": {
"type": "string"
}
},
{
"name": "filter_text",
"in": "query",
"description": "Filter text to restrict tagged objects list with matching filter text.",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "scope",
"in": "query",
"description": "Tag scope",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "Tag value",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/tags/effective-resources?scope=type&tag=app\n",
"x-vmw-nsx-module": "PolicyVpcTag",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"target_type\": \"VirtualMachine\",\n \"target_display_name\": \"App-VM-1\",\n \"target_id\": \"564d8b81-983d-b8ef-686b-161205939c58\"\n },\n {\n \"target_type\": \"Group\",\n \"target_display_name\": \"app-vms\",\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/domains/default/groups/app-vms\"\n }\n ],\n \"result_count\": 2\n}\n"
}
},
"/malware-prevention/compute-collection/{compute-collection-id}/status": {
"get": {
"tags": [
"Management Plane API",
"Security",
"Malware Prevention"
],
"summary": "Get status for MPS Compute collection.",
"description": "Returns current status of the deployment of MPS Service on a given cluster.\n",
"operationId": "GetMpsComputeCollectionStatus",
"parameters": [
{
"name": "compute-collection-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MpsComputeCollectionStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/malware-prevention/compute-collection/b81b9edc-45c9-4ac9-981d-bf717e524722:domain-c8/status\n",
"x-vmw-nsx-module": "NsxMalwarePreventionDeployment",
"x-vmw-nsx-example-response": "{\n \"compute_collection_id\": \"b81b9edc-45c9-4ac9-981d-bf717e524722:domain-c8\",\n \"deployment_status\": \"DEPLOYMENT_SUCCESSFUL\",\n \"deployment_issues\": [],\n \"transport_node_status\": [\n {\n \"transport_node_id\": \"832079fe-d8b8-4871-bd0a-d9f67a6d0ad4\",\n \"deployment_status\": \"DEPLOYMENT_SUCCESSFUL\",\n \"deployment_issues\": [],\n \"service_health_status\": [\n {\n \"service_name\": \"HOST_COMPONENT\",\n \"service_status\": \"SERVICE_STATUS_UP\",\n \"last_update_time\": \"1694159853256\",\n \"is_stale\": false\n },\n {\n \"service_name\": \"SECURITY_HUB\",\n \"service_status\": \"SERVICE_STATUS_DOWN\",\n \"last_update_time\": \"1694159853256\",\n \"is_stale\": false\n }\n ],\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"_protection\": \"NOT_PROTECTED\"\n}\n"
}
},
"/infra/domains/{domain-id}/intrusion-service-gateway-policies": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "List IDS gateway policies",
"description": "List all IDS gateway policies for specified Domain.",
"operationId": "ListIdsGatewayPolicies",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsGatewayPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/intrusion-service-gateway-policies\n",
"x-vmw-nsx-module": "PolicyIDSGateway",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"IdsGatewatPolicy\",\n \"id\": \"default\",\n \"display_name\": \"/infra/domains/vmc-domain/intrusion-service-gateway-policies/default\",\n \"path\": \"/infra/domains/vmc-domain/intrusion-service-gateway-policies/default\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"default\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 50000,\n \"category\": \"LocalGatewayRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061800,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 6\n },\n {\n \"resource_type\": \"IdsGatewayPolicy\",\n \"id\": \"internal\",\n \"display_name\": \"internal\",\n \"path\": \"/infra/domains/vmc-domain/intrusion-service-gateway-policies/internal\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"internal\",\n \"sequence_number\": 100,\n \"internal_sequence_number\": 20100,\n \"category\": \"SharedPreRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469778,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516295469778,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Transport Zones"
],
"summary": "Read a Transport Zone under an Enforcement Point",
"description": "Read a Transport Zone under an Enforcement Point\n",
"operationId": "ReadTransportZoneForEnforcementPoint",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transport-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTransportZone"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/nsxt-ep/transport-zones/tz\n",
"x-vmw-nsx-module": "PolicyTransportZone",
"x-vmw-nsx-example-response": "{\n \"tz_type\": \"OVERLAY_BACKED\",\n \"is_default\": true,\n \"nested_nsx\": false,\n \"authorized_vlans\": [\n \"5\",\n \"10-20\",\n \"25\",\n \"30-40\"\n ],\n \"resource_type\": \"PolicyTransportZone\",\n \"id\": \"tz\",\n \"display_name\": \"tz\",\n \"path\": \"/infra/sites/default/enforcement-points/default/transport-zones/tz\",\n \"relative_path\": \"tz\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n \"unique_id\": \"8f4a026d-e3f5-4f23-a3ef-46309d573dc1\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1607501697823,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1607582307987,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 5\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Transport Zones"
],
"summary": "PUT a Transport Zone under an Enforcement Point",
"description": "PUT a Transport Zone under an Enforcement Point\n",
"operationId": "CreateOrUpdateTransportZoneForEnforcementPoint",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transport-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTransportZone"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTransportZone"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/nsxt-ep/transport-zones/tz\n {\n \"tz_type\": \"OVERLAY_BACKED\",\n \"is_default\": false\n }\n",
"x-vmw-nsx-module": "PolicyTransportZone",
"x-vmw-nsx-example-response": "{\n \"tz_type\": \"OVERLAY_BACKED\",\n \"is_default\": false,\n \"nested_nsx\": false,\n \"authorized_vlans\": [\n \"5\",\n \"10-20\",\n \"25\",\n \"30-40\"\n ],\n \"resource_type\": \"PolicyTransportZone\",\n \"id\": \"tz\",\n \"display_name\": \"tz\",\n \"path\": \"/infra/sites/default/enforcement-points/default/transport-zones/tz\",\n \"relative_path\": \"tz\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n \"unique_id\": \"3341d836-00ad-4ee3-b334-8e61a215a0ab\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1607582565107,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1607582565109,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyTransportZone"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Transport Zones"
],
"summary": "Delete a Transport Zone under an Enforcement Point",
"description": "Delete a Transport Zone under an Enforcement Point.",
"operationId": "DeleteTransportZoneForEnforcementPoint",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transport-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/nsxt-ep/transport-zones/tz\n",
"x-vmw-nsx-module": "PolicyTransportZone",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Transport Zones"
],
"summary": "Patch a Transport Zone under an Enforcement Point",
"description": "Patch a Transport Zone under an Enforcement Point\n",
"operationId": "PatchTransportZoneForEnforcementPoint",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transport-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTransportZone"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTransportZone"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/nsxt-ep/transport-zones/tz\n {\n \"tz_type\": \"OVERLAY_BACKED\",\n \"is_default\": true,\n \"nested_nsx\": false,\n \"authorized_vlans\": [\n \"5\",\n \"10-20\",\n \"25\",\n \"30-40\"\n ],\n \"transport_zone_profile_paths\": [\n \"/infra/transport-zone-profiles/tzp\"\n ]\n }\n",
"x-vmw-nsx-module": "PolicyTransportZone",
"x-vmw-nsx-example-response": "{\n \"tz_type\": \"OVERLAY_BACKED\",\n \"is_default\": true,\n \"transport_zone_profile_paths\": [\n \"/infra/transport-zone-profiles/tzp\"\n ],\n \"nested_nsx\": false,\n \"authorized_vlans\": [\n \"5\",\n \"10-20\",\n \"25\",\n \"30-40\"\n ],\n \"resource_type\": \"PolicyTransportZone\",\n \"id\": \"tz2\",\n \"display_name\": \"tz2\",\n \"path\": \"/infra/sites/default/enforcement-points/default/transport-zones/tz2\",\n \"relative_path\": \"tz2\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n \"unique_id\": \"034adfef-2a9b-48b8-9a7e-05db94589aef\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1607541382550,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1607541382552,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyTransportZone"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "List Port QoS Profile Binding Maps",
"description": "API will list all Port QoS Profile Binding Maps in current port id.\n",
"operationId": "GlobalInfraListPortQoSBindings",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"PortQoSProfileBindingMaps\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/tier-1s/{tier1-id}/locale-services/{locale-services-id}/flood-protection-profile-bindings/{flood-protection-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices.\n",
"operationId": "GlobalInfraGetTier1LocaleServicesFloodProtectionProfileBinding",
"parameters": [
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "flood-protection-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/flood-protection-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/locale-services/default/flood-protection-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
}
},
"/infra/firewall-schedulers/{firewall-scheduler-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Scheduler"
],
"summary": "Get PolicyFirewallScheduler",
"description": "Get a PolicyFirewallScheduler by id\n",
"operationId": "GetPolicyFirewallScheduler",
"parameters": [
{
"name": "firewall-scheduler-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallScheduler"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/api/v1/infra/firewall-schedulers/testPolicyFirewallScheduler\n",
"x-vmw-nsx-module": "PolicyFirewallScheduler",
"x-vmw-nsx-example-response": "{\n \"resource_type\":\"PolicyFirewallScheduler\",\n \"display_name\":\"testPolicyFirewallScheduler\",\n \"description\":\"Test Policy Firewall Scheduler\",\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\"\n ],\n \"time_interval\": [{\n \"start_interval\":\"09:00\",\n \"end_interval\":\"17:00\"\n }],\n \"start_date\": \"2/22/2019\",\n \"end_date\": \"12/22/2019\",\n \"timezone\": \"UTC\",\n \"recurring\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Scheduler"
],
"summary": "Create or Update PolicyFirewallScheduler",
"description": "Updates a PolicyFirewallScheduler, which can be set at security policy.\nNote that at least one property out of \"days\", \"start_date\",\n\"time_interval\", \"end_date\" is required if \"recurring\" field is true. Also\n\"start_time\" and \"end_time\" should not be present. And if \"recurring\"\nfield is false then \"start_date\" and \"end_date\" is mandatory, \"start_time\"\nand \"end_time\" is optional. Also the fields \"days\" and \"time_interval\"\nshould not be present.\n",
"operationId": "UpdatePolicyFirewallScheduler",
"parameters": [
{
"name": "firewall-scheduler-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallScheduler"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallScheduler"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/api/v1/infra/firewall-schedulers/testPolicyFirewallScheduler\n{\n \"resource_type\":\"PolicyFirewallScheduler\",\n \"display_name\":\"testPolicyFirewallScheduler\",\n \"description\":\"Test Policy Firewall Scheduler\",\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\"\n ],\n \"time_interval\": [{\n \"start_interval\":\"09:00\",\n \"end_interval\":\"17:00\"\n }],\n \"start_date\": \"2/22/2019\",\n \"end_date\": \"12/22/2019\",\n \"timezone\": \"LOCAL\",\n \"recurring\": true\n}\n",
"x-vmw-nsx-module": "PolicyFirewallScheduler",
"x-codegen-request-body-name": "PolicyFirewallScheduler"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Scheduler"
],
"summary": "Delete Policy Firewall Scheduler",
"description": "Deletes the specified PolicyFirewallScheduler. If scheduler\nis consumed in a security policy, it won't get deleted.\n",
"operationId": "DeletePolicyFirewallScheduler",
"parameters": [
{
"name": "firewall-scheduler-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force delete the resource even if it is being used somewhere\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/api/v1/infra/firewall-schedulers/testPolicyFirewallScheduler\n",
"x-vmw-nsx-module": "PolicyFirewallScheduler"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Scheduler"
],
"summary": "Create or Update PolicyFirewallScheduler",
"description": "Creates/Updates a PolicyFirewallScheduler, which can be set at security\npolicy. Note that at least one property out of \"days\", \"start_date\",\n\"time_interval\", \"end_date\" is required if \"recurring\" field is true. Also\n\"start_time\" and \"end_time\" should not be present. And if \"recurring\"\nfield is false then \"start_date\" and \"end_date\" is mandatory, \"start_time\"\nand \"end_time\" is optional. Also the fields \"days\" and \"time_interval\"\nshould not be present.\n",
"operationId": "PatchPolicyFirewallScheduler",
"parameters": [
{
"name": "firewall-scheduler-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallScheduler"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/api/v1/infra/firewall-schedulers/testPolicyFirewallScheduler\n{\n \"resource_type\":\"PolicyFirewallScheduler\",\n \"display_name\":\"testPolicyFirewallScheduler\",\n \"description\":\"Test Policy Firewall Scheduler\",\n \"days\": [\n \"MONDAY\",\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\"\n ],\n \"start_date\": \"2/22/2019\",\n \"end_date\": \"12/22/2019\",\n \"timezone\": \"LOCAL\",\n \"recurring\": true\n}\n",
"x-vmw-nsx-module": "PolicyFirewallScheduler",
"x-codegen-request-body-name": "PolicyFirewallScheduler"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"IP Discovery Profiles"
],
"summary": "List IP Discovery Profiles",
"description": "API will list all IP Discovery Profiles active in current discovery profile id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIPDiscoveryProfiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPDiscoveryProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-discovery-profiles\n",
"x-vmw-nsx-module": "PolicyIpDiscovery",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"IPDiscoveryProfile\",\n \"display_name\": \"IPDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/ip-discovery-profiles/ipdp1\",\n \"relative_path\": \"ipdp1\",\n \"ip_v4_discovery_options\": {\n \"arp_snooping_config\": {\n \"arp_snooping_enabled\": false,\n \"arp_binding_limit\": 1\n },\n \"dhcp_snooping_enabled\": false,\n \"vmtools_enabled\": true\n },\n \"ip_v6_discovery_options\": {\n \"nd_snooping_config\": {\n \"nd_snooping_enabled\": true,\n \"nd_snooping_limit\": 2\n },\n \"dhcp_snooping_v6_enabled\": true,\n \"vmtools_v6_enabled\": true\n },\n \"tofu_enabled\": true,\n \"arp_nd_binding_timeout\": 10,\n \"duplicate_ip_detection\": {\n \"duplicate_ip_detection_enabled\": false\n },\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/realized-state/enforcement-points/{enforcement-point-name}/ip-sets/ip-sets-nsxt": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "List IPSets",
"description": "Paginated list of all Realized IPSets\n",
"operationId": "ListIPSetRealizedStates",
"parameters": [
{
"name": "enforcement-point-name",
"in": "path",
"description": "Enforcement Point Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericPolicyRealizedResourceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyRealizedState"
}
},
"/orgs/{org-id}/projects/{project-id}/aaa/roles": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Get information about all roles",
"description": "Get information about all roles",
"operationId": "ListRolesOfOrgMultitenancyProject",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "scope",
"in": "query",
"description": "List only the roles which are applicable for this scope.",
"schema": {
"type": "string",
"enum": [
"ROOT",
"ORG",
"PROJECT",
"VPC"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/orgs/default/projects/default/aaa/roles\n",
"x-vmw-nsx-module": "PolicyMultitenancyAuthorization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"role\": \"enterprise_admin\"\n },\n {\n \"role\": \"security_op\"\n },\n {\n \"role\": \"auditor\"\n },\n {\n \"role\": \"security_engineer\"\n },\n {\n \"role\": \"network_op\"\n },\n {\n \"role\": \"network_engineer\"\n }\n ]\n}\n"
}
},
"/global-infra/services/{service-id}/service-entries/{service-entry-id}": {
"get": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Service entry",
"description": "Service entry",
"operationId": "GlobalInfraReadServiceEntry",
"parameters": [
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-entry-id",
"in": "path",
"description": "Service entry ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceEntry"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/services/my-http/service-entries/https\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"https\",\n \"display_name\": \"MyHttps\",\n \"path\": \"/infra/services/my-http/service-entries/https\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"https\",\n \"destination_ports\": [\n \"7443\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517316057383,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517316057383,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/ip-addresses": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get IP addresses that belong to this Group",
"description": "Get IP addresses that belong to this Group.\nThis API is applicable for Groups containing either VirtualMachine, VIF,\nSegment ,Segment Port or IP Address member type.For Groups containing other\nmember types,an empty list is returned\n",
"operationId": "GetGroupIPMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupIPMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/ip-addresses?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 3,\n \"results\": [\n \"192.168.0.0/24\",\n \"192.168.0.1\",\n \"192.168.0.1-192.168.0.100\"\n ]\n}\n"
}
},
"/infra/sha/pre-defined-runbooks/{runbook-id}/help": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "Read help information of a Predefined Runbook",
"description": "Read help information of an Online Diagnostic System Predefined runbook.\n",
"operationId": "LoadOdsPredefinedRunbookHelpInfo",
"parameters": [
{
"name": "runbook-id",
"in": "path",
"description": "Identifier of a Predefined Runbook",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsRunbookHelpInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sha/pre-defined-runbooks/0000004f-7665-726c-6179-54756e6e656c/help\n",
"x-vmw-nsx-module": "PolicyOds",
"x-vmw-nsx-example-response": "{\n \"summary\" : \"Runbook to diagnose overlay tunnel issues.\",\n \"parameter_info\" : [ {\n \"summary\" : \"IP address of source VTEP\",\n \"parameter\" : {\n \"name\" : \"src\",\n \"optional\" : false,\n \"parameter_type\" : \"COMPOUND\"\n }\n }, {\n \"summary\" : \"IP address of destination VTEP\",\n \"parameter\" : {\n \"name\" : \"dst\",\n \"optional\" : false,\n \"parameter_type\" : \"COMPOUND\"\n }\n } ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Blocks"
],
"summary": "Read a IpAddressBlock",
"description": "Read IpAddressBlock with given Id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadIpAddressBlock",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-block-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ignore_ipblock_usage",
"in": "query",
"description": "Flag to specify whether to fetch block usage.\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressBlock"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-blocks/Finance-block\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IpAddressBlock\",\n \"id\": \"Finance-block\",\n \"display_name\": \"Finance-block\",\n \"path\": \"/infra/ip-blocks/Finance-block\",\n \"parent_path\": \"/infra/ip-blocks\",\n \"relative_path\": \"Finance-block\",\n \"cidr\": \"192.168.0.0/16\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Blocks"
],
"summary": "Create or Replace IpAddressBlock",
"description": "Create a new IpAddressBlock with given ID if it does not exist.\nIf IpAddressBlock with given ID already exists, it will update existing instance.\nThis is a full replace.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrReplaceIpAddressBlock",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-block-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressBlock"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressBlock"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/ip-blocks/Finance-block\n{\n \"display_name\": \"Finance-block\",\n \"description\": \"Finance-block\",\n \"cidr\": \"192.168.0.0/16\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IpAddressBlock\",\n \"id\": \"Finance-block\",\n \"display_name\": \"Finance-block\",\n \"path\": \"/infra/ip-blocks/Finance-block\",\n \"parent_path\": \"/infra/ip-blocks\",\n \"relative_path\": \"Finance-block\",\n \"cidr\": \"192.168.0.0/16\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "IpAddressBlock"
},
"delete": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Blocks"
],
"summary": "Delete an IpAddressBlock",
"description": "Delete the IpAddressBlock with the given id.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteIpAddressBlock",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-block-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/ip-blocks/Finance-block\n",
"x-vmw-nsx-module": "PolicyIpam"
},
"patch": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Blocks"
],
"summary": "Create a new IPBlock",
"description": "Creates a new IpAddressBlock with specified ID if not already present.\nIf IpAddressBlock of given ID is already present, then the instance is\nupdated with specified attributes.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrPatchIpAddressBlock",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ip-block-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressBlock"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ip-blocks/Finance-block\n{\n \"display_name\": \"Finance-block\",\n \"description\": \"Finance-block Description\",\n \"cidr\": \"192.168.0.0/16\"\n}\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-codegen-request-body-name": "IpAddressBlock"
}
},
"/global-infra/services/{service-id}": {
"get": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Read a service",
"description": "Read a service",
"operationId": "GlobalInfraReadServiceForTenant",
"parameters": [
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/services/my-http\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Service\",\n \"description\": \"My HTTP\",\n \"id\": \"my-http\",\n \"display_name\": \"My HTTP\",\n \"path\": \"/infra/services/my-http\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"my-http\",\n \"service_entries\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"MyHttpEntry\",\n \"display_name\": \"MyHttpEntry\",\n \"path\": \"/infra/services/my-http/service-entries/MyHttpEntry\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"MyHttpEntry\",\n \"destination_ports\": [\n \"8080\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677617,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677617,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/settings/firewall/security/malware-prevention-service/profiles": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "List Malware Prevention profiles",
"description": "List Malware Prevention profiles.\n",
"operationId": "ListMalwarePreventionProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MalwarePreventionProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles\n",
"x-vmw-nsx-module": "PolicyAntiMalware",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"file_type\": [\"PDF\"],\n \"detection_type\": \"SIGNATURE_BASED\",\n \"resource_type\": \"MalwarePreventionProfile\",\n \"id\": \"test\",\n \"display_name\": \"test\",\n \"path\": \"/infra/settings/firewall/security/malware-prevention-service/profiles/test\",\n \"relative_path\": \"test\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"68a5be83-6e25-4951-b51f-b150c2cb5e95\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1612371129205,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1612371129209,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"file_type\": [\"PDF\"],\n \"detection_type\": \"SIGNATURE_BASED\",\n \"resource_type\": \"MalwarePreventionProfile\",\n \"id\": \"test1\",\n \"display_name\": \"test1\",\n \"path\": \"/infra/settings/firewall/security/malware-prevention-service/profiles/test1\",\n \"relative_path\": \"test1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"5a42ada7-4be9-4c5e-9dce-56e6fb6c45b6\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1612371157715,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1612371157716,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"file_type\": [\"PDF\"],\n \"detection_type\": \"SIGNATURE_BASED\",\n \"resource_type\": \"MalwarePreventionProfile\",\n \"id\": \"test2\",\n \"display_name\": \"test2\",\n \"path\": \"/infra/settings/firewall/security/malware-prevention-service/profiles/test2\",\n \"relative_path\": \"test2\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"c607e9cc-1b14-4402-aea1-93284a7b43e7\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1612371160897,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1612371160898,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"file_type\": [\"PDF\"],\n \"detection_type\": \"SIGNATURE_BASED\",\n \"resource_type\": \"MalwarePreventionProfile\",\n \"id\": \"test3\",\n \"display_name\": \"test3\",\n \"path\": \"/infra/settings/firewall/security/malware-prevention-service/profiles/test3\",\n \"relative_path\": \"test3\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"a188d805-05cd-484a-a1bc-9d6db87a71ee\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1612371163682,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1612371163683,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"file_type\": [\"PDF\"],\n \"detection_type\": \"SIGNATURE_BASED\",\n \"resource_type\": \"MalwarePreventionProfile\",\n \"id\": \"test4\",\n \"display_name\": \"test4\",\n \"path\": \"/infra/settings/firewall/security/malware-prevention-service/profiles/test4\",\n \"relative_path\": \"test4\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"dd3dc772-e696-4c2e-bd83-babfe05dcd18\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1612371165557,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1612371165558,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 5,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n\n }\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Read rule",
"description": "Read rule",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadSecurityRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Create or update a rule",
"description": "Update the rule. Create new rule if a rule with the rule-id is not already\npresent.\nPerformance Note: If you wish to edit several rules in a security policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/security-policies/<security-policy-id>\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateSecurityRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n{\n \"description\": \"comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"DROP\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n],\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "Rule"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Delete rule",
"description": "Delete rule",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteSecurityRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Patch a rule",
"description": "Patch the rule. If Rule corresponding to the the given rule-id is\nnot present, the object will get created and if it is present it will be\nupdated. This is a full replace.\nPerformance Note: If you want to edit several rules in a security policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/security-policies/<security-policy-id>\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchSecurityRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n{\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc_domain/groups/webgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc_domain/groups/dbgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"DROP\",\n \"services\": [\n \"ANY\"\n ]\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-codegen-request-body-name": "Rule"
}
},
"/infra/firewall-identity-stores-org-units": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Fetch all organization units for a LDAP server.",
"description": "Fetch all organization units for a LDAP server.",
"operationId": "FetchFirewallIdentityStoreOrgUnits",
"parameters": [
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServer"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryOrgUnitListResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores-org-units\n{\n \"resource_type\": \"DirectoryAdLdapServer\",\n \"display_name\": \"nimbus ldap\",\n \"host\": \"10.92.43.247\",\n \"domain_name\": \"idfw.local\",\n \"username\": \"administrator\",\n \"password\": \"password\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"port\": 389,\n \"protocol\": \"LDAP\"\n}\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"name\": \"Domain Controllers\",\n \"distinguished_name\": \"OU=Domain Controllers,DC=idfw,DC=local\"\n },\n {\n \"name\": \"Top1OU\",\n \"distinguished_name\": \"OU=Top1OU,DC=idfw,DC=local\",\n \"children\": [\n {\n \"name\": \"B\",\n \"distinguished_name\": \"OU=B,OU=Top1OU,DC=idfw,DC=local\",\n \"children\": [\n {\n \"name\": \"BB\",\n \"distinguished_name\": \"OU=BB,OU=B,OU=Top1OU,DC=idfw,DC=local\"\n }c\n ]\n },\n {\n \"name\": \"A\",\n \"distinguished_name\": \"OU=A,OU=Top1OU,DC=idfw,DC=local\",\n \"children\": [\n {\n \"name\": \"AA\",\n \"distinguished_name\": \"OU=AA,OU=A,OU=Top1OU,DC=idfw,DC=local\"\n }\n ]\n }\n ]\n },\n {\n \"name\": \"Top2OU\",\n \"distinguished_name\": \"OU=Top2OU,DC=idfw,DC=local\",\n \"children\": [\n {\n \"name\": \"C\",\n \"distinguished_name\": \"OU=C,OU=Top2OU,DC=idfw,DC=local\"\n }\n ]\n }\n ],\n \"result_count\": 8\n}\n",
"x-codegen-request-body-name": "DirectoryLdapServer"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Get port security profile binding map",
"description": "API will return details of the port security profile binding map. If the\nsecurity profile binding map does not exist, it will return 404.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPortSecurityProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130135604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130135604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Create or replace the port security profile binding map",
"description": "API will create or replace the port security profile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdatePortSecurityProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n {\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130135604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130135604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortSecurityProfileBindingMap\",\n \"id\": \"port-security-profile-binding-map_1\",\n \"display_name\": \"port-security-profile-binding-map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port-security-profile-binding-map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1\",\n \"relative_path\": \"port-security-profile-binding-map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539130135604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539130486350,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortSecurityProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Delete the port security profile binding map",
"description": "API will delete the port security profile binding map.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeletePortSecurityProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Patch port security profile binding map",
"description": "Create a new port security profile binding map if the given security profile\nbinding map does not exist. Otherwise, patch the existing port security\nprofile binding map.\nFor objects with no binding maps, default profile is applied.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchPortSecurityProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "port id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-security-profile-binding-map-id",
"in": "path",
"description": "port security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortSecurityProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/ports/port_1/port-security-profile-binding-maps/port_security_binding_map_1\n {\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguard_1\",\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segment_security_1\"\n }\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-codegen-request-body-name": "PortSecurityProfileBindingMap"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interface Groups"
],
"summary": "List Tier-0 Interface groups",
"description": "Paginated list of all Tier-0 Interface groups under locale service.\n",
"operationId": "ListTier0InterfaceGroup",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0InterfaceGroupListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/t0/locale-services/ls1/interface-groups\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Tier0InterfaceGroup\",\n \"id\": \"group1\",\n \"display_name\": \"group1\",\n \"path\": \"/infra/tier-0s/t0/locale-services/ls1/interface-groups/group1\",\n \"parent_path\": \"/infra/tier-0s/t0/locale-services/ls1\",\n \"relative_path\": \"group1\",\n \"members\": [\n {\n \"interface_path\": \"/infra/tier-0s/t0/locale-services/interfaces/ls1/intf1\"\n },\n {\n \"interface_path\": \"/infra/tier-0s/t0/locale-services/interfaces/ls1/intf2\"\n }\n ],\n \"source_nat_ip_pool\": [\n \"pool1\",\n \"pool2\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/tags/effective-resources": {
"get": {
"tags": [
"Policy",
"Inventory",
"Tags"
],
"summary": "List all objects assigned with matching scope and tag values",
"description": "Paginated list of all objects assigned with matching scope and tag values. Objects\nare represented in form of resource reference. Sort option is available only on\ntarget_type and target_display_name properties.\n",
"operationId": "GlobalInfraListTaggedObjects",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "filter_by",
"in": "query",
"description": "Comma-separated list of field names to filter tagged objects.",
"schema": {
"type": "string"
}
},
{
"name": "filter_text",
"in": "query",
"description": "Filter text to restrict tagged objects list with matching filter text.",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "scope",
"in": "query",
"description": "Tag scope",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "Tag value",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tags/effective-resources?scope=type&tag=app\n",
"x-vmw-nsx-module": "PolicyTag",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"target_type\": \"VirtualMachine\",\n \"target_display_name\": \"App-VM-1\",\n \"target_id\": \"564d8b81-983d-b8ef-686b-161205939c58\"\n },\n {\n \"target_type\": \"Group\",\n \"target_display_name\": \"app-vms\",\n \"path\": \"/infra/domains/default/groups/app-vms\"\n }\n ],\n \"result_count\": 2\n}\n"
}
},
"/infra/firewall-session-timer-profiles": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profiles"
],
"summary": "List Firewall Session Timer Profiles",
"description": "API will list all Firewall Session Timer Profiles",
"operationId": "ListPolicyFirewallSessionTimerProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallSessionTimerProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/firewall-session-timer-profiles\n",
"x-vmw-nsx-module": "PolicyFirewallSessionTimerProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PolicyFirewallSessionTimerProfile\",\n \"description\": \"\",\n \"name\":\"profile-1\",\n \"id\":\"profile-1\",\n \"display_name\": \"profile-1\",\n \"path\": \"/infra/firewall-session-timer-profiles/profile-1\",\n \"relative_path\": \"profile-1\",\n \"tcp_first_packet\": 120,\n \"tcp_opening\": 30,\n \"tcp_established\": 43200,\n \"tcp_closing\": 900,\n \"tcp_finwait\": 20,\n \"tcp_closed\": 10,\n \"udp_first_packet\": 60,\n \"udp_single\": 30,\n \"udp_multiple\": 60,\n \"icmp_first_packet\": 20,\n \"icmp_error_reply\": 10,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster/{cluster-id}/ncpstatus": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Heatmap"
],
"summary": "Get the container cluster status by given id",
"description": "Get the container cluster status by given id",
"operationId": "GetContainerClusterStatus",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-id",
"in": "path",
"description": "ID of container cluster",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContainerClusterSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/container-cluster/49bb701-4fe9-11e9-bdc7-000c29e49f11/ncpstatus\n",
"x-vmw-nsx-module": "PolicyHeatmap",
"x-vmw-nsx-example-response": "{\n \"cluster_id\": \"49bb701-4fe9-11e9-bdc7-000c29e49f11\",\n \"cluster_name\": \"PKS-Cluster-2\",\n \"type\": \"PKS\",\n \"status\": \"HEALTHY\",\n \"detail\":\"\",\n \"interval\": 180\n}\n"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"Heatmap"
],
"summary": "Delete container cluster status",
"description": "Delete container cluster status",
"operationId": "DeleteContainerClusterStatus",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster-id",
"in": "path",
"description": "ID of container cluster",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/container-cluster/b8b0889f-338c-5c65-98bd-a5642ae2aa00/ncpstatus\n",
"x-vmw-nsx-module": "PolicyHeatmap"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/firewall-session-timer-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Bindings"
],
"summary": "List Firewall Session Timer Profile Binding Maps",
"description": "API will list all Firewall Session Timer Profile Binding Maps in current group id.\n",
"operationId": "ListPolicyFirewallSessionTimerBindings",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallSessionTimerProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-session-timer-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyFirewallSessionTimerProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PolicyFirewallSessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"binding-map-1\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-session-timer-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallSessionTimerProfileBindingMaps\",\n \"firewall_session_timer_profile_path\":\"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/groups/{group-id}/members/ip-addresses": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get IP addresses that belong to this Tier-0 Group",
"description": "Get IP addresses that belong to this Tier-0 Group.\nThis API is applicable for Groups containing either VirtualMachine, VIF,\nSegment ,Segment Port or IP Address member type.For Groups containing other\nmember types,an empty list is returned\n",
"operationId": "GlobalInfraGetProviderGroupIPMembers",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupIPMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/t1/groups/g1/members/ip-addresses?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 3,\n \"results\": [\n \"192.168.0.0/24\",\n \"192.168.0.1\",\n \"192.168.0.1-192.168.0.100\"\n ]\n}\n"
}
},
"/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Edge Bridge Profiles"
],
"summary": "List L2 Bridge Endpoint Profiles",
"description": "List all L2 bridge profiles",
"operationId": "GlobalInfraListL2BridgeProfiles",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2BridgeEndpointProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-bridge-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-points/default/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\"\n ],\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"failover_mode\": \"PREEMPTIVE\",\n \"resource_type\": \"L2BridgeEndpointProfile\",\n \"id\": \"p2\",\n \"display_name\": \"p2\",\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p2\",\n \"relative_path\": \"p2\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n \"unique_id\": \"55971354-aa4b-45dd-bb4f-0a37aaea2181\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579296711399,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579296711399,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/vifs": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Virtual Network Interface instances that belong to this Group",
"description": "Get Virtual Network Interface instances that belong to this Group.\nThis API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types.\nFor Groups containing other member types,an empty list is returned.target_id in response\nis external_id of VirtualNetworkInterface or VirtualMachine.\n",
"operationId": "GetGroupVIFMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualNetworkInterfaceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/vifs?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"external_id\": \"564dda4e-bc05-061c-dac7-7a314e0e0c9c-4000\",\n \"owner_vm_id\": \"1778a2b0-7f9b-4c64-806c-bc13d6d60762\",\n \"owner_vm_type\": \"REGULAR\",\n \"host_id\": \"28477562-ea6f-11e9-9c84-f98983786a98\",\n \"vm_local_id_on_host\": \"1\",\n \"device_key\": \"4000\",\n \"device_name\": \"Network adapter 1\",\n \"mac_address\": \"00:0c:29:0e:0c:9c\",\n \"ip_address_info\": [\n {\n \"source\": \"VM_TOOLS\",\n \"ip_addresses\": [\n \"10.170.66.155\",\n \"fd01:3:4:2825:c5dc:25a5:fbb9:6762\",\n \"fd01:3:4:2825:2c49:a400:48df:23dd\",\n \"fd01:3:4:2825:34ca:5670:96e0:6edf\",\n \"fd01:3:4:2825:d9e4:5e51:6df6:c93e\",\n \"fd01:3:4:2825:b002:86da:30d4:1030\",\n \"fd01:3:4:2825:20c:29ff:fe0e:c9c\",\n \"fe80::20c:29ff:fe0e:c9c\",\n \"fd01:3:4:2825:eddf:5879:67d5:6293\",\n \"fd01:3:4:2825:f027:6316:8de5:3a29\"\n ]\n }\n ],\n \"resource_type\": \"VirtualNetworkInterface\",\n \"display_name\": \"Network adapter 1\",\n \"_last_sync_time\": 0\n }\n],\n\"result_count\": 1,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/compliance/status": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Compliance"
],
"summary": "Returns the compliance status",
"description": "Returns the compliance status and details of non compliant configuration",
"operationId": "GetPolicyComplianceStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyComplianceStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/compliance/status\n",
"x-vmw-nsx-module": "PolicyCompliance",
"x-vmw-nsx-example-response": "{\n \"last_updated_time\" : 1535016210856,\n \"non_compliant_configs\": [\n {\n \"description\": \"TLS version 1.0 used for establishing secure socket connection. It is recommended to run TLSv 1.1 or higher and fully deactivate TLSv1.0 that have protocol weaknesses.\",\n \"reported_by\": {\n \"target_display_name\": \"test-profile\",\n \"is_valid\": true,\n \"target_type\": \"LB_CLIENT_SSL_PROFILE\",\n \"target_id\": \"/infra/lb-client-ssl-profiles/test-profile\",\n \"path\": \"/infra/lb-client-ssl-profiles/test-profile\"\n },\n \"non_compliance_code\": 72022\n }\n]\n}\n"
}
},
"/ui-views/{view-id}/widgetconfigurations/{widgetconfiguration-id}": {
"get": {
"tags": [
"System Administration",
"Monitoring",
"Dashboards",
"Widget Configuration"
],
"summary": "Returns Widget Configuration Information",
"description": "Returns Information about a specific Widget Configuration.\n\n
\nThis API is deprecated and will be unavailable in later releases.",
"operationId": "GetWidgetConfiguration",
"parameters": [
{
"name": "view-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "widgetconfiguration-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WidgetConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/ui-views/dashboard/widgetconfigurations/\nLabelValueConfiguration_BackupStatus\n",
"x-vmw-nsx-module": "NsxDashboard",
"x-vmw-nsx-example-response": "{\n \"id\": \"LabelValueConfiguration_0de8406c-ab4a-4973-83ef-a1c7a6655c13\",\n \"resource_type\": \"LabelValueConfiguration\",\n \"display_name\": \"Backups\",\n \"datasources\": [{\n \"urls\": [{\n \"alias\": \"config\",\n \"url\": \"api/v1/cluster/backups/config\"\n },{\n \"alias\": \"status\",\n \"url\": \"api/v1/cluster/backups/history\"\n }],\n \"display_name\": \"default\"\n }],\n \"navigation\": \"nsxapi/index.html#view=systemAdmin/utilities/backup\",\n \"feature_set\": {\n \"feature_list\": [\"utilities_backup\"],\n \"require_all_permissions\": false\n },\n \"footer\": {\n \"actions\": [{\n \"dock_to_container_footer\": true,\n \"label\": {\n \"text\": \"Configure Backups\"\n },\n \"url\": \"nsxapi/index.html#view=systemAdmin/utilities/backup\"\n }]\n },\n \"properties\": [{\n \"condition\": \"#{default.config.backup_enabled} == true\",\n \"field\": \"\\\"Automatic Backups Enabled\\\"\",\n \"heading\": true,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"SUCCESS\"\n }]\n }],\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.config.backup_enabled} == false\",\n \"field\": \"\\\"Automatic Backups Disabled\\\"\",\n \"heading\": true,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"NOT_AVAILABLE\"\n },{\n \"type\": \"DETAIL\",\n \"placement\": \"POST\",\n \"tooltip\": [{\n \"text\": \"\\\"Please enable automatic backups\\\"\"\n }]\n }]\n }],\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.status.node_backup_statuses}.size() == 0\",\n \"field\": \"\\\"Not Configured\\\"\",\n \"heading\": false,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"WARNING\"\n }]\n }],\n \"label\": {\n \"text\": \"Node\"\n },\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.status.node_backup_statuses}.size() != 0\",\n \"field\": \"#{default.status.node_backup_statuses[0].end_time}\",\n \"heading\": false,\n \"render_configuration\": [{\n \"condition\": \"#{default.status.node_backup_statuses[0].success}\",\n \"icons\": [{\n \"type\": \"SUCCESS\"\n }]\n },{\n \"condition\": \"#{default.status.node_backup_statuses[0].success} == false\",\n \"icons\": [{\n \"type\": \"ERROR\"\n }]\n }],\n \"label\": {\n \"text\": \"Node\"\n },\n \"type\": \"Date\"\n }],\n \"_create_user\": \"admin\",\n \"_create_time\": 1496911709362,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1496911709362,\n \"_system_owned\": false,\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"System Administration",
"Monitoring",
"Dashboards",
"Widget Configuration"
],
"summary": "Update Widget Configuration",
"description": "Updates the widget at the given view. If the widget is referenced by other\nviews, then the widget will be updated in all the views that it is part of.\n\n
\nThis API is deprecated and will be unavailable in later releases.",
"operationId": "UpdateWidgetConfiguration",
"parameters": [
{
"name": "view-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "widgetconfiguration-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WidgetConfiguration"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WidgetConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/api/v1/ui-views/dashboard_custom/widgetconfigurations/\nLabelValueConfiguration_0de8406c-ab4a-4973-83ef-a1c7a6655c13\n{\n \"id\": \"LabelValueConfiguration_0de8406c-ab4a-4973-83ef-a1c7a6655c13\",\n \"resource_type\": \"LabelValueConfiguration\",\n \"display_name\": \"Backups Updated\",\n \"datasources\": [{\n \"urls\": [{\n \"alias\": \"config\",\n \"url\": \"api/v1/cluster/backups/config\"\n },{\n \"alias\": \"status\",\n \"url\": \"api/v1/cluster/backups/history\"\n }],\n \"display_name\": \"default\"\n }],\n \"navigation\": \"nsxapi/index.html#view=systemAdmin/utilities/backup\",\n \"feature_set\": {\n \"feature_list\": [\"utilities_backup\"],\n \"require_all_permissions\": false\n },\n \"footer\": {\n \"actions\": [{\n \"dock_to_container_footer\": true,\n \"label\": {\n \"text\": \"Configure Backups\"\n },\n \"url\": \"nsxapi/index.html#view=systemAdmin/utilities/backup\"\n }]\n },\n \"properties\": [{\n \"condition\": \"#{default.config.backup_enabled} == true\",\n \"field\": \"\\\"Automatic Backups Enabled\\\"\",\n \"heading\": true,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"SUCCESS\"\n }]\n }],\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.config.backup_enabled} == false\",\n \"field\": \"\\\"Automatic Backups Disabled\\\"\",\n \"heading\": true,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"NOT_AVAILABLE\"\n },{\n \"type\": \"DETAIL\",\n \"placement\": \"POST\",\n \"tooltip\": [{\n \"text\": \"\\\"Please enable automatic backups\\\"\"\n }]\n }]\n }],\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.status.node_backup_statuses}.size() == 0\",\n \"field\": \"\\\"Not Configured\\\"\",\n \"heading\": false,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"WARNING\"\n }]\n }],\n \"label\": {\n \"text\": \"Node\"\n },\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.status.node_backup_statuses}.size() != 0\",\n \"field\": \"#{default.status.node_backup_statuses[0].end_time}\",\n \"heading\": false,\n \"render_configuration\": [{\n \"condition\": \"#{default.status.node_backup_statuses[0].success}\",\n \"icons\": [{\n \"type\": \"SUCCESS\"\n }]\n },{\n \"condition\": \"#{default.status.node_backup_statuses[0].success} == false\",\n \"icons\": [{\n \"type\": \"ERROR\"\n }]\n }],\n \"label\": {\n \"text\": \"Node\"\n },\n \"type\": \"Date\"\n }],\n \"_create_user\": \"admin\",\n \"_create_time\": 1496911709362,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1496911709362,\n \"_system_owned\": false,\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "NsxDashboard",
"x-vmw-nsx-example-response": "{\n \"id\": \"LabelValueConfiguration_0de8406c-ab4a-4973-83ef-a1c7a6655c13\",\n \"resource_type\": \"LabelValueConfiguration\",\n \"display_name\": \"Backups Updated\",\n \"datasources\": [{\n \"urls\": [{\n \"alias\": \"config\",\n \"url\": \"api/v1/cluster/backups/config\"\n },{\n \"alias\": \"status\",\n \"url\": \"api/v1/cluster/backups/history\"\n }],\n \"display_name\": \"default\"\n }],\n \"navigation\": \"nsxapi/index.html#view=systemAdmin/utilities/backup\",\n \"feature_set\": {\n \"feature_list\": [\"utilities_backup\"],\n \"require_all_permissions\": false\n },\n \"footer\": {\n \"actions\": [{\n \"dock_to_container_footer\": true,\n \"label\": {\n \"text\": \"Configure Backups\"\n },\n \"url\": \"nsxapi/index.html#view=systemAdmin/utilities/backup\"\n }]\n },\n \"properties\": [{\n \"condition\": \"#{default.config.backup_enabled} == true\",\n \"field\": \"\\\"Automatic Backups Enabled\\\"\",\n \"heading\": true,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"SUCCESS\"\n }]\n }],\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.config.backup_enabled} == false\",\n \"field\": \"\\\"Automatic Backups Disabled\\\"\",\n \"heading\": true,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"NOT_AVAILABLE\"\n },{\n \"type\": \"DETAIL\",\n \"placement\": \"POST\",\n \"tooltip\": [{\n \"text\": \"\\\"Please enable automatic backups\\\"\"\n }]\n }]\n }],\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.status.node_backup_statuses}.size() == 0\",\n \"field\": \"\\\"Not Configured\\\"\",\n \"heading\": false,\n \"render_configuration\": [{\n \"icons\": [{\n \"type\": \"WARNING\"\n }]\n }],\n \"label\": {\n \"text\": \"Node\"\n },\n \"type\": \"String\"\n },{\n \"condition\": \"#{default.status.node_backup_statuses}.size() != 0\",\n \"field\": \"#{default.status.node_backup_statuses[0].end_time}\",\n \"heading\": false,\n \"render_configuration\": [{\n \"condition\": \"#{default.status.node_backup_statuses[0].success}\",\n \"icons\": [{\n \"type\": \"SUCCESS\"\n }]\n },{\n \"condition\": \"#{default.status.node_backup_statuses[0].success} == false\",\n \"icons\": [{\n \"type\": \"ERROR\"\n }]\n }],\n \"label\": {\n \"text\": \"Node\"\n },\n \"type\": \"Date\"\n }],\n \"_create_user\": \"admin\",\n \"_create_time\": 1496911718391,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1496911718391,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "WidgetConfiguration"
},
"delete": {
"tags": [
"System Administration",
"Monitoring",
"Dashboards",
"Widget Configuration"
],
"summary": "Delete Widget Configuration",
"description": "Detaches widget from a given view. If the widget is no longer part of any\nview, then it will be purged.\n\n
\nThis API is deprecated and will be unavailable in later releases.",
"operationId": "DeleteWidgetConfiguration",
"parameters": [
{
"name": "view-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "widgetconfiguration-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/api/v1/ui-views/dashboard_custom/\nwidgetconfigurations/LabelValueConfiguration_BackupStatus\n",
"x-vmw-nsx-module": "NsxDashboard"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/routes?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"OSPF"
],
"summary": "Get OSPF route information in CSV format",
"description": "Get OSPF route information in CSV format.\n",
"operationId": "GetOspfRoutesInCsvFormat",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "network_prefix",
"in": "query",
"description": "CIDR network address",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/OspfRoutesListResultInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s//locale-services//ospf/routes?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\nedge_path,route_prefix,route_type,router_type,cost,type_to_cost,area,\"next_hop_neighbor_address\",next_hop_interface_name,\"next_hop_directly_attached\"\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0\",40.50.60.0/24,\"N E2\",,10,20,,90.90.90.10,uplink-270,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0\",10.172.148.0/22,\"N E2\",,10,20,,90.90.90.10,uplink-270,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0\",40.40.40.0/24,N,,10,0,0.0.0.0,0.0.0.0,uplink-269,true\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0\",90.90.90.0/24,N,,10,0,0.0.0.0,0.0.0.0,uplink-270,true\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0\",2.1.5.0/24,\"N E2\",,10,20,,90.90.90.10,uplink-270,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/0\",90.90.90.10,\"R \",,10,0,0.0.0.0,90.90.90.10,uplink-270,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1\",40.50.60.0/24,\"N E2\",,65534,20,0.0.0.0,90.90.90.10,uplink-283,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1\",10.172.148.0/22,\"N E2\",,65534,20,0.0.0.0,90.90.90.10,uplink-283,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1\",40.40.40.0/24,N,,65544,0,0.0.0.0,90.90.90.2,uplink-283,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1\",90.90.90.0/24,N,,65534,0,0.0.0.0,0.0.0.0,uplink-283,true\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1\",2.1.5.0/24,\"N E2\",,65534,20,0.0.0.0,90.90.90.10,uplink-283,false\n\"/infra/sites/default/enforcement-points/default/edge-clusters/29618e38-18a1-4ffc-aa91-8487d0cf9131/edge-nodes/1\",90.90.90.10,\"R \",,65534,0,0.0.0.0,90.90.90.10,uplink-283,false\n}\n"
}
},
"/infra/features/detailed-view": {
"get": {
"tags": [
"Policy",
"Feature Flag",
"Aggregated Feature State Details"
],
"summary": "Read Aggregated Feature State with details",
"description": "Paginated list of all Aggregated Feature State with details",
"operationId": "ListAggregatedFeatureStateDetails",
"parameters": [
{
"name": "site_path",
"in": "query",
"description": "null",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatedFeatureDetailListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/features/detailed-view?site_path=/infra/site/default\n",
"x-vmw-nsx-module": "PolicyFeatureFlags"
}
},
"/infra/sites/settings/firewall/security": {
"get": {
"tags": [
"Federation",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Distributed Firewall Settings"
],
"summary": "Get global distributed firewall configurations for all the sites",
"description": "Get global distributed firewall configurations for all the sites.",
"operationId": "ListAllGlobalDfwConfigurations",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalDfwConfigurationListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/global-manager/api/v1/global-infra/sites/settings/firewall/security\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"GlobalDfwConfiguration\",\n \"id\": \"security\",\n \"display_name\": \"security\",\n \"path\": \"/global-infra/sites/london/settings/firewall/security\",\n \"relative_path\": \"security\",\n \"marked_for_delete\": false,\n \"enable_firewall\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1554274751846,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1554274751846,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/firewall-identity-stores/{firewall-identity-store-id}/groups/{group-id}/member-groups": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Groups"
],
"summary": "List members of a directory group",
"description": "A member group could be either direct member of the group specified by group_id or nested member of it. Both direct member groups and nested member groups are returned. Directory group member sync must be enabled to get the correct results.",
"operationId": "ListFirewallIdentityStoreGroupMemberGroups",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Directory group identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryGroupMemberListResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/123e4567-e89b-12d3-a456-42665544000/groups/1abfda06-fc00-11e7-8450-fea9aa178066/member-groups\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"DirectoryGroupMember\",\n \"id\": \"877c5fd0-7ee2-424e-9bff-66a169f6ded4\",\n \"display_name\": \"877c5fd0-7ee2-424e-9bff-66a169f6ded4\",\n \"group_id\": \"1bd85e69-6eac-416c-80c0-bd8203d76146\",\n \"group_distinguished_name\": \"CN=test6grp,CN=Users,DC=nimbustest,DC=com\",\n \"member_group_id\": \"2cab9258-3413-4787-8d9e-60986985cd3a\",\n \"member_group_distinguished_name\": \"CN=test5grp,CN=Users,DC=nimbustest,DC=com\",\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1516663042822,\n \"_system_owned\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1516661730906,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/host-transport-nodes/state": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Nodes"
],
"summary": "List transport nodes by realized state",
"description": "Returns a list of transport node states that have realized state as provided\nas query parameter.\nIf this API is called multiple times in parallel then it\nwill fail with error indicating that another request is already in progress.\nIn such case, try the API on another NSX manager instance (if exists) or try\nagain after some time.\n",
"operationId": "ListHostTransportNodesByState",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mm_state",
"in": "query",
"description": "maintenance mode state",
"schema": {
"type": "string",
"enum": [
"ENTERING",
"ENABLED",
"EXITING",
"DISABLED"
]
}
},
{
"name": "status",
"in": "query",
"description": "Realized state of transport nodes",
"schema": {
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"SUCCESS",
"PARTIAL_SUCCESS",
"FAILED",
"ORPHANED"
]
}
},
{
"name": "vtep_ip",
"in": "query",
"description": "Virtual tunnel endpoint ip address of transport node",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransportNodeStateListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/state?status=IN_PROGRESS\n",
"x-vmw-nsx-module": "PolicyHostTransportNode",
"x-vmw-nsx-example-response": "{\n \"state\" : \"in_progress\",\n \"node_deployment_state\": \"success\",\n \"transport_node_id\" : \"366048ba-89d9-435e-ac2e-2c7cf6ed0f33\",\n \"host_switch_states\" : [\n {\n \"state\" : \"in_progress\",\n \"host_switch_id\" : \"58 20 ca 9e ff da 40 19-86 06 39 d2 0c 0a d7 c5\",\n \"endpoints\" : [\n {\n \"subnet_mask\" : \"255.255.255.224\",\n \"device_name\" : \"vmk10\",\n \"label\" : 593280,\n \"default_gateway\" : \"\",\n \"ip\" : \"169.254.177.12\"\n }\n ],\n \"host_switch_name\" : \"opaque-switch-1\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier1-id}/locale-services/{locale-services-id}/session-timer-profile-bindings/{session-timer-profile-binding-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will create or update Session Timer profile binding map for Tier-1 Logical Router LocaleServices.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateTier1LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n {\n \"resource_type\":\"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"description\": \"\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices",
"description": "API will delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTier1LocaleServicesSessionTimerProfileBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Session Timer Profile Binding"
],
"summary": "Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices",
"description": "API will create or update Session Timer profile binding map for Tier-1 Logical Router LocaleServices.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchTier1LocaleServicesSessionTimerProfileBindingMap",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-timer-profile-binding-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionTimerProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/my-t1/locale-services/default/session-timer-profile-bindings/default\n {\n \"resource_type\": \"SessionTimerProfileBindingMap\",\n \"profile_path\": \"/infra/firewall-session-timer-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyGatewayProfileBinding",
"x-codegen-request-body-name": "SessionTimerProfileBindingMap"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet"
],
"summary": "Get VPC Subnet",
"description": "Get VPC Subnet\n",
"operationId": "GetVpcSubnet",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnet"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "{\n \"id\": \"subnet-1\",\n \"resource_type\": \"VpcSubnet\",\n \"display_name\": \"Subnet 1\",\n \"description\": \"This is test VpcSubnet\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\",\n \"access_mode\": \"Private\",\n \"ip_addresses\": [\"10.112.2.0/24\"],\n \"ipv4_subnet_size\":64 #<-- optional\n \"dhcp_config\": {\n \"enable_dhcp\": true,\n \"static_pool_config\" : {\n \"ipv4_pool_size\": 60\n }\n },\n \"_create_time\": 1515745891661,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1515745891661,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet"
],
"summary": "Update the VPC Subnet",
"description": "Update the VPC Subnet.\n",
"operationId": "UpdateVpcSubnet",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnet"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnet"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\n{\n \"id\": \"subnet-1\",\n \"resource_type\": \"VpcSubnet\",\n \"display_name\": \"Subnet 1\",\n \"description\": \"This is test VpcSubnet\",\n \"access_mode\": \"Private\",\n \"ip_addresses\": [\"10.112.2.0/24\"], #IPv4, IPv6 -- could be empty which means \"AUTO\"\n \"ipv4_subnet_size\":64,\n \"dhcp_config\": {\n \"enable_dhcp\": true\n },\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "{\n \"id\": \"subnet-1\",\n \"resource_type\": \"VpcSubnet\",\n \"display_name\": \"Subnet 1\",\n \"description\": \"This is test VpcSubnet\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\",\n \"access_mode\": \"Private\",\n \"ip_addresses\": [\"10.112.2.0/24\"],\n \"ipv4_subnet_size\":64,\n \"dhcp_config\": {\n \"enable_dhcp\": true\n },\n \"_create_time\": 1515745891661,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1515745891661,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "VpcSubnet"
},
"delete": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet"
],
"summary": "Delete VPC Subnet",
"description": "Delete VPC Subnet.\n",
"operationId": "DeleteVpcSubnet",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\n",
"x-vmw-nsx-module": "PolicyVpcSubnet"
},
"patch": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet"
],
"summary": "Create or update VPC Subnet",
"description": "If a VPC Subnet with the subnet-id is not already present, create a new VPC Subnet.\nIf it already exists, update the VPC Subnet.\n",
"operationId": "PatchVpcSubnet",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnet"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\n{\n \"display_name\": \"Subnet 1\",\n \"description\": \"This is test VpcSubnet\",\n \"access_mode\": \"Private\",\n \"ip_addresses\": [\"10.112.2.0/24\"], # IPv4, IPv6 -- could be empty which means \"AUTO\"\n \"ipv4_subnet_size\":64\n}\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "VpcSubnet"
}
},
"/infra/sha/plugin-profiles/{sha-profile-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "API will return Sha profile",
"description": "API will return Sha profile.\n",
"operationId": "ReadShaPluginProfile",
"parameters": [
{
"name": "sha-profile-id",
"in": "path",
"description": "Sha profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPluginProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sha/plugin-profiles/profile1\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ShaPluginProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"/infra/sha/plugin-profiles/profile1\",\n \"path\": \"/infra/sha/plugin-profiles/profile1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile1\",\n \"plugin_path\": \"/infra/sha/pre-defined-plugins/daemon-health\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n \"plugin_type\": \"PredefinedPlugin\",\n \"enabled\": true,\n \"config\": {\n \"check_interval\": 30,\n \"report_interval\": 180,\n \"smallest_report_interval_if_change\": 60\n }\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Create or Replace Sha profile",
"description": "Create or Replace Sha profile.\n",
"operationId": "CreateOrReplaceShaPluginProfile",
"parameters": [
{
"name": "sha-profile-id",
"in": "path",
"description": "Sha profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPluginProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPluginProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/sha/plugin-profiles/profile1\n {\n \"plugin_path\": \"/infra/sha/pre-defined-plugins/daemon-health\",\n \"plugin_type\": \"PredefinedPlugin\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n \"enabled\": true,\n \"config\": {\n \"check_interval\": 20,\n \"report_interval\": 180,\n \"smallest_report_interval_if_change\": 60\n }\n }\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ShaPluginProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"/infra/sha/plugin-profiles/profile1\",\n \"path\": \"/infra/sha/plugin-profiles/profile1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile1\",\n \"plugin_path\": \"/infra/sha/pre-defined-plugins/daemon-health\",\n \"plugin_type\": \"PredefinedPlugin\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n \"enabled\": true,\n \"config\": {\n \"check_interval\": 20,\n \"report_interval\": 180,\n \"smallest_report_interval_if_change\": 60\n }\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "ShaPluginProfile"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Delete SHA profile",
"description": "Delete Sha profile.\n",
"operationId": "DeleteShaPluginProfile",
"parameters": [
{
"name": "sha-profile-id",
"in": "path",
"description": "Sha profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/sha/plugin-profiles/profile1\n",
"x-vmw-nsx-module": "PolicySha"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Create or Replace SHA profile",
"description": "Create or Replace Sha profile.\n",
"operationId": "PatchShaPluginProfile",
"parameters": [
{
"name": "sha-profile-id",
"in": "path",
"description": "Sha profile id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPluginProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPluginProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/sha/plugin-profiles/profile1\n {\n \"config\": {\n \"check_interval\": 30,\n }\n }\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ShaPluginProfile\",\n \"id\": \"profile1\",\n \"display_name\": \"/infra/sha/plugin-profiles/profile1\",\n \"path\": \"/infra/sha/plugin-profiles/profile1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"profile1\",\n \"plugin_path\": \"/infra/sha/pre-defined-plugins/daemon-health\",\n \"plugin_type\": \"PredefinedPlugin\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n \"enabled\": true,\n \"config\": {\n \"check_interval\": 30,\n \"report_interval\": 180,\n \"smallest_report_interval_if_change\": 60\n }\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "ShaPluginProfile"
}
},
"/infra/drafts/{draft-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Read draft",
"description": "Read a draft for a given draft identifier.\n",
"operationId": "ReadDraft",
"parameters": [
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDraft"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft\n",
"x-vmw-nsx-module": "PolicyDraft",
"x-vmw-nsx-example-response": "{\n \"is_auto_draft\": true,\n \"system_area\": {\n \"resource_type\": \"Infra\",\n \"id\": \"infra\",\n \"display_name\": \"infra\",\n \"path\": \"/infra\",\n \"children\": [\n {\n \"children\": [\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-1\",\n \"display_name\": \"app-section-1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 1,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"target_type\": \"Domain\",\n \"resource_type\": \"ChildResourceReference\",\n \"id\": \"default\",\n \"marked_for_delete\": false,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"resource_type\": \"PolicyDraft\",\n \"id\": \"test_draft\",\n \"display_name\": \"test_draft\",\n \"path\": \"/infra/drafts/test_draft\",\n \"relative_path\": \"test_draft\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"8703dd3b-7978-48a5-ab94-10cc50848829\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1607333111465,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1607333111468,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Create or update a manual draft",
"description": "Create a new manual draft if the specified draft id does not correspond\nto an existing draft. Update the manual draft otherwise.\nAuto draft can not be updated.\n",
"operationId": "PutDraft",
"parameters": [
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDraft"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDraft"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft\n",
"x-vmw-nsx-module": "PolicyDraft",
"x-vmw-nsx-example-response": "{\n \"is_auto_draft\": false,\n \"system_area\": {\n \"resource_type\": \"Infra\",\n \"id\": \"infra\",\n \"display_name\": \"infra\",\n \"path\": \"/infra\",\n \"children\": [\n {\n \"children\": [\n {\n \"SecurityPolicy\": {\n \"logging_enabled\": false,\n \"resource_type\": \"SecurityPolicy\",\n \"id\": \"app-section-1\",\n \"display_name\": \"app-section-1\",\n \"path\": \"/infra/domains/default/security-policies/app-section-1\",\n \"marked_for_delete\": true,\n \"overridden\": false,\n \"sequence_number\": 1,\n \"category\": \"Application\",\n \"stateful\": true,\n \"tcp_strict\": true,\n \"locked\": false,\n \"scope\": [\n \"ANY\"\n ],\n \"is_default\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"resource_type\": \"ChildSecurityPolicy\",\n \"marked_for_delete\": true,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"target_type\": \"Domain\",\n \"resource_type\": \"ChildResourceReference\",\n \"id\": \"default\",\n \"marked_for_delete\": false,\n \"mark_for_override\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n \"locked\": false,\n \"lock_modified_time\": 0,\n \"resource_type\": \"PolicyDraft\",\n \"id\": \"test_draft\",\n \"display_name\": \"test_draft\",\n \"path\": \"/infra/drafts/test_draft\",\n \"relative_path\": \"test_draft\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"8703dd3b-7978-48a5-ab94-10cc50848829\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1607333111465,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1607333111468,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyDraft"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Delete a manual draft",
"description": "Delete a manual draft.",
"operationId": "DeleteDraft",
"parameters": [
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft\n",
"x-vmw-nsx-module": "PolicyDraft"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Drafts"
],
"summary": "Patch a manual draft",
"description": "Create a new manual draft if the specified draft id does not correspond\nto an existing draft. Update the manual draft otherwise.\nAuto draft can not be updated.\n",
"operationId": "PatchDraft",
"parameters": [
{
"name": "draft-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDraft"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/drafts/test_draft\n",
"x-vmw-nsx-module": "PolicyDraft",
"x-codegen-request-body-name": "PolicyDraft"
}
},
"/global-infra/segments/{segment-id}/segment-qos-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "List Segment QoS Profile Binding Maps",
"description": "API will list all Segment QoS Profile Binding Maps in current segment id.\n",
"operationId": "GlobalInfraListInfraSegmentQoSBindings",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/segment-qos-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/segments/segment_1/segment-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "List Port QoS Profile Binding Maps",
"description": "API will list all Port QoS Profile Binding Maps in current port id.\n",
"operationId": "ListPortQoSBindings",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortQoSProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-qos-profile-binding-maps/1\",\n \"relative_path\": \"PortQoSProfileBindingMaps\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/domains/{domain-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Domains",
"Domain"
],
"summary": "Read domain",
"description": "Read a domain.\n",
"operationId": "GlobalInfraReadDomainForInfra",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Domain"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Domain\",\n \"description\": \"VMC Domain\",\n \"id\": \"vmc\",\n \"display_name\": \"VMC domain\",\n \"path\": \"/infra/domains/vmc\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"vmc\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517307910473,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517307910473,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"MAC Table"
],
"summary": "Get Tier-1 segment MAC table in CSV",
"description": "Returns MAC table for a segment\n",
"operationId": "GlobalInfraGetTier1SegmentMacTableInCsv",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/MacAddressCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/TIER0_DOWN_LINK_SWITCH/mac-table?format=csv&source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,mac_type\n00:0c:29:ce:0f:77,STATIC\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"State"
],
"summary": "Get infra segment state information",
"description": "Get infra segment state information.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentState",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentConfigurationState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/tier0-ls/state?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_switch_id\": \"211fe0fb-ae0c-4e16-9560-4b7647adefd8\",\n \"state\": \"success\",\n \"details\": []\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "Get segment security profile binding map",
"description": "API will return details of the segment security profile binding map. If the\nbinding map does not exist, it will return 404.\n",
"operationId": "GlobalInfraGetSegmentSecurityProfileBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-security-profile-binding-map-id",
"in": "path",
"description": "segment security profile binding map id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentSecurityProfileBindingMap\",\n \"id\": \"segment_security_binding_map_1\",\n \"display_name\": \"segment_security_binding_map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1\",\n \"relative_path\": \"segment_security_binding_map_1\",\n \"marked_for_delete\": false,\n \"segment_security_profile_path\": \"/infra/segment-security-profiles/segmentsecurityprofile_1\",\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539129320511,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129320511,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/settings/firewall/cpu-mem-thresholds-profiles/{profile-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Read the CPU and memory thresholds profile",
"description": "Read the CPU and memory thresholds profile.",
"operationId": "ReadCPUMemThresholdsProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCpuMemThresholdsProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/default\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyFirewallCpuMemThresholdsProfile\",\n \"id\" : \"default\",\n \"display_name\" : \"default-cpu-mem-thresholds-profile\",\n \"path\" : \"/infra/settings/firewall/cpu-mem-thresholds-profiles/default\",\n \"parent_path\" : \"/infra\",\n \"relative_path\" : \"default\",\n \"cpu_threshold_percentage\" : 10,\n \"mem_threshold_percentage\" : 20\n \"_create_user\" : \"admin\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Create or update CPU and memory thresholds profile",
"description": "Create or update CPU and memory thresholds profile.",
"operationId": "UpdateCPUMemThresholdsProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCpuMemThresholdsProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCpuMemThresholdsProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/default\n{\n \"display_name\" : \"default-cpu-mem-thresholds-profile\",\n \"cpu_threshold_percentage\" : 10,\n \"mem_threshold_percentage\" : 20\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"PolicyFirewallCpuMemThresholdsProfile\",\n \"id\" : \"default\",\n \"display_name\" : \"default-cpu-mem-thresholds-profile\",\n \"path\" : \"/infra/settings/firewall/cpu-mem-thresholds-profiles/default\",\n \"parent_path\" : \"/infra\",\n \"relative_path\" : \"default\",\n \"cpu_threshold_percentage\" : 10,\n \"mem_threshold_percentage\" : 20\n \"_create_user\" : \"admin\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n",
"x-codegen-request-body-name": "PolicyFirewallCpuMemThresholdsProfile"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Delete CPU and memory thresholds profile",
"description": "Delete CPU and memory thresholds profile.",
"operationId": "DeleteCPUMemThresholdsProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/default\n",
"x-vmw-nsx-module": "PolicyProfile"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Cpu Memory Thresholds Profiles"
],
"summary": "Create or update CPU and memory thresholds profile",
"description": "Create or update CPU and memory thresholds profile.",
"operationId": "PatchCPUMemThresholdsProfile",
"parameters": [
{
"name": "profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallCpuMemThresholdsProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/default\n{\n \"display_name\" : \"default-cpu-mem-thresholds-profile\",\n \"cpu_threshold_percentage\" : 10,\n \"mem_threshold_percentage\" : 20\n}\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-codegen-request-body-name": "PolicyFirewallCpuMemThresholdsProfile"
}
},
"/global-infra/firewall/policies": {
"get": {
"tags": [
"Policy",
"Security"
],
"summary": "Get policies filtered based on the given criteria",
"description": "Get the list of policies filtered based on the given criteria.\n",
"operationId": "GlobalInfraGetFilteredPolicies",
"parameters": [
{
"name": "enforcement_point_path",
"in": "query",
"description": "Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "parent_path",
"in": "query",
"description": "Path of the parent object of the entities",
"schema": {
"type": "string"
}
},
{
"name": "scope",
"in": "query",
"description": "Scope filter criteria",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/firewall/policies?scope=6f1c310b-aeed-445e-aef9-9722c8967ab8&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1\",\n \"target_id\" : \"sp1\",\n \"target_type\" : \"SECURITY_POLICY\",\n \"is_valid\" : \"true\"\n },\n {\n \"path\" : \"/infra/domains/default/security-policies/sp2\",\n \"target_id\" : \"sp2\",\n \"target_type\" : \"SECURITY_POLICY\",\n \"is_valid\" : \"true\"\n }\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/ip-address-expressions/{expression-id}": {
"post": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Groups"
],
"summary": "Add or Remove IP Addresses from/to a Group\n",
"description": "It will add or remove the specified IP Addresses from a given expression of a group.\n",
"operationId": "AddorRemoveGroupIPAddresses",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expression-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Add or Remove group members.",
"required": true,
"schema": {
"type": "string",
"enum": [
"add",
"remove"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddressList"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST /infra/domains/default/groups/IPGroup/ip-address-expressions/ipaddressexp?action=add\n{\n\"ip_addresses\": [\n \"10.110.9.4-10.110.9.10\",\n \"10.110.9.3/24\"\n ]\n}\n\nPOST /infra/domains/default/groups/IPGroup/ip-address-expressions/ipaddressexp?action=remove\n{\n\"ip_addresses\": [\n \"10.110.9.4-10.110.9.10\",\n \"10.110.9.3/24\"\n ]\n}\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "IPAddressList"
},
"delete": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Groups"
],
"summary": "Delete Group IPAddressExpression",
"description": "Delete Group IPAddressExpression",
"operationId": "DeleteGroupIPAddressExpression",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expression-id",
"in": "path",
"description": "IPAddressExpression ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/vmc/groups/webgroup/ip-address-expressions/exp1\n",
"x-vmw-nsx-module": "Policy"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Groups"
],
"summary": "Patch a group IP Address expression",
"description": "If a group IPAddressExpression with the expression-id is not already present, create a new IPAddressExpression.\nIf it already exists, replace the existing IPAddressExpression.\n",
"operationId": "PatchGroupIPAddressExpressionForDomain",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expression-id",
"in": "path",
"description": "IPAddressExpression ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddressExpression"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/vmc/groups/webgroup/ip-address-expressions/exp1\n{\n \"ip_addresses\": [\n \"10.110.9.21\",\n \"10.112.9.22\"\n ],\n \"resource_type\": \"IPAddressExpression\",\n \"id\" : \"exp1\"\n}\n",
"x-vmw-nsx-module": "Policy",
"x-codegen-request-body-name": "IPAddressExpression"
}
},
"/infra/sites/napp/registration/{cluster-id}": {
"get": {
"tags": [
"NSX Application Platform",
"Registration"
],
"summary": "Get a registered NSX Application Platform as specified",
"description": "Get the registered NSX Application Platform as specified.\n",
"operationId": "GetNappRegistration",
"parameters": [
{
"name": "cluster-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NappRegistration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sites/napp/registration/12f563af-af9f-48f3-848e-e9257c8740b0\n",
"x-vmw-nsx-module": "PolicyNappRegistration",
"x-vmw-nsx-example-response": "{\n \"cluster_id\": \"12f563af-af9f-48f3-848e-e9257c8740b0\",\n \"cluster_name\": \"NSX Application Platform\",\n \"message_bus_ip_address\": \"10.33.76.94\",\n \"ingress_ip_address\": \"10.33.76.80\",\n \"status\": \"DEPLOYMENT_SUCCESSFUL\"\n}\n"
}
},
"/infra/livetraces/{livetrace-id}/forward/capturefile": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Livetrace"
],
"summary": "Get forward packet capture file for the specified livetrace session",
"description": "You must provide the request header\n\"Accept:application/octet-stream\" when calling this API.\nThe capture file can only be found in MP which receives the capture request.\n",
"operationId": "GetLiveTraceForwardPktCapFile",
"parameters": [
{
"name": "livetrace-id",
"in": "path",
"description": "Livetrace session ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/livetraces/t01/forward/capturefile\n",
"x-vmw-nsx-module": "PolicyConnectivity"
}
},
"/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Locale Services"
],
"summary": "Read Tier-1 locale-services",
"description": "Read Tier-1 locale-services",
"operationId": "GlobalInfraReadTier1LocaleServices",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleServices"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services/palo_alto\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"LocaleServices\",\n \"id\": \"palo_alto\",\n \"display_name\": \"Palo Alto\",\n \"path\": \"/infra/tier-1s/cgw/locale-services/default\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"palo_alto\",\n \"edge_cluster_path\": \"/infra/sites/default/enforcement-points/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd\",\n \"preferred_edge_paths\": [ \"/infra/sites/default/enforcement-points/nsx/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\" ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "Get Segment Monitoring Profile Binding Map",
"description": "API will get Segment Monitoring Profile Binding Map.\n",
"operationId": "GetSegmentMonitoringBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-monitoring-profile-binding-map-id",
"in": "path",
"description": "Segment Monitoring Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMonitoringProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentMonitoringProfileBindingMap\",\n \"description\": \"\",\n \"name\":\"1\",\n \"id\":\"1\",\n \"display_name\": \"SegmentMonitoringProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1\",\n \"relative_path\": \"SegmentMonitoringProfileBindingMaps\",\n \"port_mirroring_profile_path\":\"/infra/port-mirroring-profiles/1\",\n \"ipfix_l2_profile_path\":\"/infra/ipfix-l2-profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "Update Segment Monitoring Profile Binding Map",
"description": "API will update Segment Monitoring Profile Binding Map.",
"operationId": "UpdateSegmentMonitoringBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-monitoring-profile-binding-map-id",
"in": "path",
"description": "Segment Monitoring Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMonitoringProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMonitoringProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1\n{\n \"resource_type\":\" SegmentMonitoringProfileBindingMap\",\n \"display_name\": \"SegmentMonitoringProfileBindingMap Profile Production\",\n \"name\":\"1\",\n \"description\":\"\",\n \"port_mirroring_profile_path\":\"/infra/port-mirroring-profiles/1\",\n \"ipfix_l2_profile_path\":\"/infra/ipfix-l2-profiles/1\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentMonitoringProfileBindingMap\",\n \"description\": \"\",\n \"name\":\"1\",\n \"id\":\"1\",\n \"display_name\": \"SegmentMonitoringProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1\",\n \"relative_path\": \"SegmentMonitoringProfileBindingMaps\",\n \"port_mirroring_profile_path\":\"/infra/port-mirroring-profiles/1\",\n \"ipfix_l2_profile_path\":\"/infra/ipfix-l2-profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SegmentMonitoringProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "Delete Segment Monitoring Profile Binding Profile",
"description": "API will delete Segment Monitoring Profile Binding Profile.",
"operationId": "DeleteSegmentMonitoringBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-monitoring-profile-binding-map-id",
"in": "path",
"description": "Segment Monitoring Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "Create Segment Monitoring Profile Binding Map",
"description": "API will create segment monitoring profile binding map.",
"operationId": "PatchSegmentMonitoringBinding",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-monitoring-profile-binding-map-id",
"in": "path",
"description": "Segment Monitoring Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMonitoringProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1\n {\n \"resource_type\":\" SegmentMonitoringProfileBindingMap\",\n \"display_name\": \"SegmentMonitoringProfileBindingMap Profile Production\",\n \"name\":\"1\",\n \"description\":\"\",\n \"port_mirroring_profile_path\":\"/infra/port-mirroring-profiles/1\",\n \"ipfix_l2_profile_path\":\"/infra/ipfix-l2-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding",
"x-codegen-request-body-name": "SegmentMonitoringProfileBindingMap"
}
},
"/infra/sha/dynamic-runbook-instances": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "List Dynamic Runbook Instances",
"description": "List Online Diagnostic System Dynamic Runbooks Instances.\n",
"operationId": "ListOdsDynamicRunbookInstance",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsDynamicdRunbookInstanceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sha/dynamic-runbook-instances\n",
"x-vmw-nsx-module": "PolicyOds",
"x-vmw-nsx-example-response": "{\n \"results\" : [ {\n \"resource_type\" : \"OdsDynamicRunbookInstance\",\n \"id\" : \"instance-1\",\n \"display_name\" : \"instance-1\",\n \"path\" : \"/infra/sha/dynamic-runbook-instances/instance-1\",\n \"applied_to_group_paths\": [\"/infra/domains/default/groups/TNGroup\"],\n \"applied_to_all_appliances\": false,\n \"relative_path\" : \"instance-1\",\n \"parent_path\" : \"/infra\",\n \"unique_id\" : \"f100859f-c35d-4369-9a47-3c35a44e7228\",\n \"realization_id\" : \"f100859f-c35d-4369-9a47-3c35a44e7228\",\n \"marked_for_delete\" : false,\n \"overridden\" : false,\n \"_create_time\" : 1655123260752,\n \"_create_user\" : \"system\",\n \"_last_modified_time\" : 1655123260752,\n \"_last_modified_user\" : \"system\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 0\n }\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interface Groups"
],
"summary": "List Tier-1 Interface groups",
"description": "Paginated list of all Tier-1 Interface groups under locale service.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1InterfaceGroup",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier1InterfaceGroupListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/locale-services/ls1/interface-groups\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"type\": \"SERVICE\",\n \"interface_connectivity\": [\n {\n \"urpf_mode\": \"STRICT\",\n \"subnets\": [\n {\n \"ip_addresses\": [\n {\n \"start\": \"0.0.0.0\",\n \"end\": \"40.40.40.40\",\n \"prefix_length\": 24\n }\n ]\n }\n ]\n }\n ],\n \"resource_type\": \"Tier1InterfaceGroup\",\n \"id\": \"group1\",\n \"display_name\": \"group1\",\n \"path\": \"/infra/tier-1s/t1/locale-services/ls1/interface-groups/group1\",\n \"parent_path\": \"/infra/tier-1s/t1/locale-services/ls1\",\n \"relative_path\": \"group1\",\n \"members\": [\n {\n \"interface_path\": \"/infra/tier-1s/t1/locale-services/ls1/interfaces/intf1\"\n },\n {\n \"interface_path\": \"/infra/tier-1s/t1/locale-services/ls1/interfaces/intf2\"\n }\n ],\n \"source_nat_ip_pool\": [\n \"pool1\",\n \"pool2\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/routes": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Multicast"
],
"summary": "Get Multicast Routes",
"description": "Get Multicast Routes.\n",
"operationId": "GetPolicyMulticastRoutes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyMulticastRoutes"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-0s/tier0/locale-services/tier0localeservices/multicast/routes\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"gateway_path\": \"/infra/tier-0s/tier0\",\n \"mcast_routes_per_edge\": [\n {\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a9b95292-51f7-11ea-ae0d-005056a3c9f4\",\n \"mcast_routes\": []\n },\n {\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a96e2790-51f7-11ea-aedf-005056a370d4\",\n \"mcast_routes\": [\n {\n \"source_address\": \"1.1.5.10\",\n \"group\": \"239.102.102.102\",\n \"input_interface\": \"downlink-279\",\n \"output_interface\": \"uplink-278\",\n \"ttl\": 1,\n \"uptime\": \"00:07:55\"\n },\n {\n \"source_address\": \"1.1.5.10\",\n \"group\": \"239.102.102.102\",\n \"input_interface\": \"downlink-279\",\n \"output_interface\": \"pimreg\",\n \"ttl\": 1,\n \"uptime\": \"00:07:55\"\n },\n {\n \"source_address\": \"*\",\n \"group\": \"239.101.101.101\",\n \"input_interface\": \"uplink-278\",\n \"output_interface\": \"downlink-279\",\n \"ttl\": 1,\n \"uptime\": \"11:55:29\"\n },\n {\n \"source_address\": \"*\",\n \"group\": \"239.101.101.101\",\n \"input_interface\": \"uplink-278\",\n \"output_interface\": \"pimreg\",\n \"ttl\": 1,\n \"uptime\": \"11:55:29\"\n }\n ]\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/ipsec-vpn-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Services"
],
"summary": "Get IPSec VPN service list result",
"description": "Get paginated list of all IPSec VPN services\nunder Tier-1.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1VpnIPSecVpnServices",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"IPSecVpnService\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default\",\n \"enabled\" : false,\n \"bypass_rules\" : [],\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies",
"Statistics"
],
"summary": "Get forwarding policy statistics.",
"description": "Get aggregated stattistics of Forwarding Policy.\nStats include total number of packets and total number of bytes for all\nForwarding rules in a given Forwarding Policy.\n- no enforcement point path specified: Stats will be evaluated on each enforcement\n point.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "GetForwardingPolicyStats",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "forwarding-policy-id",
"in": "path",
"description": "Forwarding policy id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingPolicyStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1\n /statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyForwardingStats",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"enforcement_point\": \"/infra/sites/default/enforcement-points/default\",\n \"statistics\": {\n \"internal_section_id\": \"fcb7390d-8289-4a0e-9cee-5423748cc544\",\n \"results\": [\n {\n \"internal_rule_id\": \"1\",\n \"packet_count\": 3806,\n \"byte_count\": 322989,\n \"_schema\": \"ForwardingRule\"\n }\n ],\n \"result_count\": 1\n }\n }\n ],\n \"result_count\": 1\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code": {
"post": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Sessions"
],
"summary": "Create or patch an L2VPN session under Tier-0 from Peer Codes",
"description": "Create or patch an L2VPN session under Tier-0 from Peer Codes.\nIn addition to the L2VPN Session, the IPSec VPN Session, along\nwith the IKE, Tunnel, and DPD Profiles are created and owned by\nthe system. IPSec VPN Service and Local Endpoint are created only\nwhen required, i.e., an IPSec VPN Service does not already exist,\nor an IPSec VPN Local Endpoint with same local address does not\nalready exist.\nUpdating the L2VPN Session can be performed only through this API\nby specifying new peer codes. Use of specific APIs to update the\nL2VPN Session and the different resources associated with it is\nnot allowed, except for IPSec VPN Service and Local Endpoint,\nresources that are not system owned.\nAPI supported only when L2VPN Service is in Client Mode.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.\n\n
\nThis API is deprecated. Please use POST /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code instead.\n",
"operationId": "CreateOrPatchL2VPNSessionFromPeerCodes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNSessionData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/locale-services/default/l2vpn-services/default/sessions/stretched-pa-site?action=create_with_peer_codes\n{\n \"description\": \"Stretched Palo Alto Site\",\n \"display_name\": \"stretched-pa-site\",\n \"transport_tunnels\": [\n {\n \"peer_code\": \"MCw0YTc2YTNlLHsic2l0ZU5hbWUiOiJwb2xpY3ktc2Vzc2lvbi1QUk9WSURFUi5obWl6YS5wYS1wdW5lLXJiLXZwbiIs\n InNyY1RhcElwIjoiMTY5LjI1NC42NC4yIiwiZHN0VGFwSXAiOiIxNjkuMjU0LjY0LjEiLCJpa2VPcHRpb24iOiJpa2V2\n MiIsImVuY2FwUHJvdG8iOiJncmUvaXBzZWMiLCJkaEdyb3VwIjoiZGgxNCIsImVuY3J5cHRBbmREaWdlc3QiOiJhZXMt\n Z2NtL3NoYS0yNTYiLCJwc2siOiJkZWZhdWx0IiwidHVubmVscyI6W3sibG9jYWxJZCI6IjI0LjI0LjI0LjI0IiwicGVl\n cklkIjoiMTEuMTEuMTEuMTEifV19\",\n \"peer_address\": \"10.10.10.10\",\n \"local_address\": \"20.20.20.20\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyLayer2VPN",
"x-codegen-request-body-name": "L2VPNSessionData"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/members/vifs": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Virtual Network Interface instances that belong to this Group",
"description": "Get Virtual Network Interface instances that belong to this Group.\nThis API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types.\nFor Groups containing other member types,an empty list is returned.target_id in response\nis external_id of VirtualNetworkInterface or VirtualMachine.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGroupVIFMembers",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualNetworkInterfaceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/vifs?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"external_id\": \"564dda4e-bc05-061c-dac7-7a314e0e0c9c-4000\",\n \"owner_vm_id\": \"1778a2b0-7f9b-4c64-806c-bc13d6d60762\",\n \"owner_vm_type\": \"REGULAR\",\n \"host_id\": \"28477562-ea6f-11e9-9c84-f98983786a98\",\n \"vm_local_id_on_host\": \"1\",\n \"device_key\": \"4000\",\n \"device_name\": \"Network adapter 1\",\n \"mac_address\": \"00:0c:29:0e:0c:9c\",\n \"ip_address_info\": [\n {\n \"source\": \"VM_TOOLS\",\n \"ip_addresses\": [\n \"10.170.66.155\",\n \"fd01:3:4:2825:c5dc:25a5:fbb9:6762\",\n \"fd01:3:4:2825:2c49:a400:48df:23dd\",\n \"fd01:3:4:2825:34ca:5670:96e0:6edf\",\n \"fd01:3:4:2825:d9e4:5e51:6df6:c93e\",\n \"fd01:3:4:2825:b002:86da:30d4:1030\",\n \"fd01:3:4:2825:20c:29ff:fe0e:c9c\",\n \"fe80::20c:29ff:fe0e:c9c\",\n \"fd01:3:4:2825:eddf:5879:67d5:6293\",\n \"fd01:3:4:2825:f027:6316:8de5:3a29\"\n ]\n }\n ],\n \"resource_type\": \"VirtualNetworkInterface\",\n \"display_name\": \"Network adapter 1\",\n \"_last_sync_time\": 0\n }\n],\n\"result_count\": 1,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "List rules",
"description": "List rules",
"operationId": "ListSecurityRules",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/domains/{domain-id}/security-policies/{security-policy-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Statistics"
],
"summary": "Get security policy statistics",
"description": "Get statistics of a security policy.\n- no enforcement point path specified: Stats will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "GlobalInfraGetSecurityPolicyStatistics",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"description": "Security policy id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicyStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/communciation-maps/emergency/statistics?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n {\n \"rule\": \"ce-1\",\n \"packet_count\": 3806,\n \"session_count\": 819,\n \"hit_count\": 45,\n \"byte_count\": 322989,\n \"popularity_index\": 85,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n },\n {\n \"rule\": \"ce-2\",\n \"packet_count\": 8762,\n \"session_count\": 62,\n \"hit_count\": 45,\n \"byte_count\": 76201,\n \"popularity_index\": 13,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n }\n ],\n \"cursor\" : 1,\n \"result_count\" : 2\n}\n"
}
},
"/infra/tags/effective-resources": {
"get": {
"tags": [
"Policy",
"Inventory",
"Tags"
],
"summary": "List all objects assigned with matching scope and tag values",
"description": "Paginated list of all objects assigned with matching scope and tag values. Objects\nare represented in form of resource reference. Sort option is available only on\ntarget_type and target_display_name properties.\n",
"operationId": "ListTaggedObjects",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "filter_by",
"in": "query",
"description": "Comma-separated list of field names to filter tagged objects.",
"schema": {
"type": "string"
}
},
{
"name": "filter_text",
"in": "query",
"description": "Filter text to restrict tagged objects list with matching filter text.",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "scope",
"in": "query",
"description": "Tag scope",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "Tag value",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tags/effective-resources?scope=type&tag=app\n",
"x-vmw-nsx-module": "PolicyTag",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"target_type\": \"VirtualMachine\",\n \"target_display_name\": \"App-VM-1\",\n \"target_id\": \"564d8b81-983d-b8ef-686b-161205939c58\"\n },\n {\n \"target_type\": \"Group\",\n \"target_display_name\": \"app-vms\",\n \"path\": \"/infra/domains/default/groups/app-vms\"\n }\n ],\n \"result_count\": 2\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/{sig-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Settings",
"Signatures"
],
"summary": "Get IDS Custom Signature",
"description": "Get IDS Custom Signature.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIdsCustomSignature",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sig-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsCustomSignature"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/version-1/custom-signatures/1001060921\n",
"x-vmw-nsx-module": "PolicyIDSCustomSignature",
"x-vmw-nsx-example-response": "{\n\"original_signature_id\": \"1060921\",\n\"validation_status\": \"VALID\",\n\"resource_type\": \"IdsCustomSignature\",\n\"id\": \"1001060921\",\n\"path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures/1001060921\",\n\"relative_path\": \"1001060921\",\n\"parent_path\": \"/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test\",\n\"marked_for_delete\": false,\n\"overridden\": false,\n\"name\": \"NSX - Detect Zeus activity\",\n\"class_type\": \"trojan-activity\",\n\"severity\": \"CRITICAL\",\n\"signature_revision\": \"3007\",\n\"signature_id\": \"1001060921\",\n\"categories\": [\n \"APPLICATION\"\n],\n\"cvssv3\": \"0.0\",\n\"cvssv2\": \"0.0\",\n\"attack_target\": \"Client_Endpoint\",\n\"product_affected\": \"NONE\",\n\"flow\": \"established,to_client\",\n\"action\": \"reject\",\n\"enable\": true,\n\"impact\": \"80\",\n\"risk_score\": \"100\",\n\"confidence\": \"80\",\n\"signature\": \"reject http $EXTERNAL_NET any -> $HOME_NET any (msg:\\\"NSX - Detect Zeus activity\\\"; flow:established,to_client; target:dest_ip; content:\\\"|00 00 00 00 8D|L|C8 15 F6|dps|C7|VQ5|03|C|DD|&\\\"; pcre:\\\"/^\\\\x00\\\\x00\\\\x00\\\\x00\\\\x8DL\\\\xC8\\\\x15\\\\xF6dps\\\\xC7VQ5\\\\x03C\\\\xDD&/Q\\\"; threshold: type limit, track by_dst, seconds 180, count 1; metadata:ll_verifier_outcome successful, flip_endpoints True, server_side False, threat_class_name command&control, threat_name Zeus Variant, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 80, severity 100, detector_id 60921, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060921; rev:3007; priority:1;)\",\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_create_time\": 1717743290322,\n\"_create_user\": \"admin\",\n\"_last_modified_time\": 1717743290322,\n\"_last_modified_user\": \"admin\",\n\"_revision\": 0\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/forwarding-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Forwarding Table"
],
"summary": "Get forwarding table from tier-0 in CSV format",
"description": "Get forwarding table from tier-0 gateway in CSV format.\n",
"operationId": "GetTier0ForwardingTableCsv",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "component_type",
"in": "query",
"description": "Define the DR routes.",
"schema": {
"type": "string",
"enum": [
"DR_ROUTES"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_id",
"in": "query",
"description": "UUID of edge node",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "network_prefix",
"in": "query",
"description": "IPAddress or CIDR Block",
"schema": {
"type": "string",
"format": "address-or-cidr-block"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "route_source",
"in": "query",
"description": "Filter routes based on the source from which route is learned",
"schema": {
"type": "string",
"enum": [
"BGP",
"STATIC",
"CONNECTED",
"OSPF"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/GatewayRouteTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/forwarding-table?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "route_type,network,interface,next_hop,admin_distance,lr_component_id,lr_component_type\nNSX_INTERNAL,0.0.0.0/0,/infra/tier-0s/t0/locale-services/default/interfaces/public1,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nNSX_INTERNAL,100.64.1.0/31,,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nNSX_INTERNAL,100.64.1.1/32,,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,169.0.0.0/28,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,172.16.10.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,1l72.16.20.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,172.16.30.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\n"
}
},
"/infra/ip-pools/{ip-pool-id}/ip-subnets": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "List IpAddressPoolSubnets",
"description": "Paginated list of IpAddressPoolSubnets.\n",
"operationId": "ListIpAddressPoolSubnets",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPoolSubnetListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1/ip-subnets\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"IpAddressPoolBlockSubnet\",\n \"id\": \"Subnet-1\",\n \"display_name\": \"Subnet-1\",\n \"path\": \"/infra/ip-pools/IpPool-Tenant-1/ip-subnets/Subnet-1\",\n \"parent_path\": \"/infra/ip-pools/IpPool-Tenant-1/ip-subnets\",\n \"relative_path\": \"Subnet-1\",\n \"size\": \"16\",\n \"ip_block_path\":\"/infra/ip-blocks/Finance-block\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machines": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Virtual Machines"
],
"summary": "List all virtual machines for this VPC",
"description": "This API lists the Virtual Machines for this VPC. Only those VMs are listed\nwhich are connected to the subnets of this VPC.\n",
"operationId": "ListAllVpcVirtualMachines",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/virtual-machines\n",
"x-vmw-nsx-module": "PolicyVpcVMs",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"compute_ids\": [\n \"moIdOnHost:1\",\n \"hostLocalId:1\",\n \"locationId:564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"instanceUuid:04fb2e78-e4bc-416f-b9dc-18b9f05e6227\",\n \"externalId:564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"biosUuid:564d75b2-7e28-7e78-dd77-64e5fd6128e1\"\n ],\n \"resource_type\": \"VirtualMachine\",\n \"external_id\": \"564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"source\": {\n \"target_display_name\": \"sc-rdops-vm09-dhcp-16-203.eng.vmware.com\",\n \"is_valid\": true,\n \"target_type\": \"HostNode\",\n \"target_id\": \"1afea8da-d4e2-11e7-93c3-c57b39f75a4f\"\n },\n \"_last_sync_time\": 1512031301409,\n \"display_name\": \"1-vm_ubuntu_1404_srv_64-local-586-04fb2e78-e4bc-416f-b9dc-18b9f05e6227\",\n \"type\": \"REGULAR\",\n \"power_state\": \"VM_RUNNING\",\n \"host_id\": \"1afea8da-d4e2-11e7-93c3-c57b39f75a4f\",\n \"local_id_on_host\": \"1\"\n }\n ]\n}\n"
}
},
"/infra/sha/dynamic-runbook-instances/{instance-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "Read a Dynamic Runbook Instance",
"description": "Read Online Diagnostic System Dynamic Runbook Instance.\n",
"operationId": "ReadOdsDynamicRunbookInstance",
"parameters": [
{
"name": "instance-id",
"in": "path",
"description": "Identifier of a Dynamic Runbook Instance",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsDynamicRunbookInstance"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sha/dynamic-runbook-instances/instance-1\n",
"x-vmw-nsx-module": "PolicyOds",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"OdsDynamicRunbookInstance\",\n \"id\" : \"instance-1\",\n \"display_name\" : \"instance-1\",\n \"path\" : \"/infra/sha/dynamic-runbook-instances/instance-1\",\n \"applied_to_group_paths\": [\"/infra/domains/default/groups/TNGroup\"],\n \"applied_to_all_appliances\": false,\n \"relative_path\" : \"instance-1\",\n \"parent_path\" : \"/infra\",\n \"unique_id\" : \"f100859f-c35d-4369-9a47-3c35a44e7228\",\n \"realization_id\" : \"f100859f-c35d-4369-9a47-3c35a44e7228\",\n \"marked_for_delete\" : false,\n \"overridden\" : false,\n \"_create_time\" : 1655123260752,\n \"_create_user\" : \"system\",\n \"_last_modified_time\" : 1655123260752,\n \"_last_modified_user\" : \"system\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 0\n}\n"
},
"post": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "Create a Dynamic Runbook Instance",
"description": "Create an Online Diagnostic System Dynamic Runbook Instance with the specified identifier\n",
"operationId": "UpdateOdsDynamicRunbookInstance",
"parameters": [
{
"name": "instance-id",
"in": "path",
"description": "Identifier of a Dynamic Runbook Instance",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsDynamicRunbookInstance"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsDynamicRunbookInstance"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/sha/dynamic-runbook-instances/instance-1\n\n{\n \"applied_to_group_paths\": [\"/infra/domains/default/groups/TNGroup\"],\n \"applied_to_all_appliances\": false,\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyOds",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"OdsDynamicRunbookInstance\",\n \"id\" : \"instance-1\",\n \"display_name\" : \"instance-1\",\n \"path\" : \"/infra/sha/dynamic-runbook-instances/instance-1\",\n \"applied_to_group_paths\": [\"/infra/domains/default/groups/TNGroup\"],\n \"applied_to_all_appliances\": false,\n \"relative_path\" : \"instance-1\",\n \"parent_path\" : \"/infra\",\n \"unique_id\" : \"f100859f-c35d-4369-9a47-3c35a44e7228\",\n \"realization_id\" : \"f100859f-c35d-4369-9a47-3c35a44e7228\",\n \"marked_for_delete\" : false,\n \"overridden\" : false,\n \"_create_time\" : 1655123260752,\n \"_create_user\" : \"system\",\n \"_last_modified_time\" : 1655123260752,\n \"_last_modified_user\" : \"system\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n}\n",
"x-codegen-request-body-name": "OdsDynamicRunbookInstance"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "Delete the Dynamic Runbook Instance",
"description": "Delete the Dynamic Runbook Instance",
"operationId": "DeleteOdsDynamicRunbookInstance",
"parameters": [
{
"name": "instance-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/sha/dynamic-runbook-instances/instance-1\n",
"x-vmw-nsx-module": "PolicyOds"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "Create or update a Dynamic Runbook Instance",
"description": "Create an Online Diagnostic System Dynamic Runbook Instance with the specified identifier\nif not existed, or update an existing Online Diagnostic System Dynamic Runbook Instance\notherwise.\n",
"operationId": "PatchOdsDynamicRunbookInstance",
"parameters": [
{
"name": "instance-id",
"in": "path",
"description": "Identifier of a Dynamic Runbook Instance",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsDynamicRunbookInstance"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsDynamicRunbookInstance"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/dynamic-runbook-instances/instance-1\n\n{\n \"applied_to_group_paths\": [\"/infra/domains/default/groups/TNGroup\"],\n \"applied_to_all_appliances\": false,\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyOds",
"x-vmw-nsx-example-response": "",
"x-codegen-request-body-name": "OdsDynamicRunbookInstance"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Read rule",
"description": "Read rule",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadGatewayRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Update gateway rule",
"description": "Update the gateway rule.\nCreate new rule if a rule with the rule-id is not already present.\nPerformance Note: If you want to edit several rules in a gateway policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>\n\nConcurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrReplaceGatewayRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\n{\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"services\": [\"/infra/services/HTTP\"],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\":\"ALLOW\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "Rule"
},
"delete": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Delete rule",
"description": "Delete rule",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteGatewayRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall"
},
"patch": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Update gateway rule",
"description": "Update the gateway rule.\nCreate new rule if a rule with the rule-id is not already present.\nPerformance Note: If you want to edit several rules in a gateway policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>\n\nConcurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchGatewayRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\n{\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/tier-0s/vmc/groups/source\"\n ],\n \"services\": [\"/infra/services/HTTP\"],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-0s/vmc\"\n ],\n \"action\":\"ALLOW\"\n}\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-codegen-request-body-name": "Rule"
}
},
"/infra/realized-state/status": {
"get": {
"tags": [
"Policy",
"Infra",
"Realized State"
],
"summary": "Get consolidated status of an intent object",
"description": "Get Consolidated Status of an intent object (with or without enforcement specific status details).\nThe request is evaluated as follows:\n- <intent_path>: the request is evaluated on all enforcement points for the given intent without\nenforcement point specific details.\n- <intent_path, include_enforced_status>: the request is evaluated on all enforcement points for\nthe given intent with enforcement point specific details.\n",
"operationId": "ReadIntentStatus",
"parameters": [
{
"name": "include_enforced_status",
"in": "query",
"description": "Include Enforced Status Flag",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "intent_path",
"in": "query",
"description": "Policy Path of the intent object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "site_path",
"in": "query",
"description": "Policy Path of the site from where the realization status needs to be fetched",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolidatedRealizedStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/realized-state/status?intent_path=/infra/domains/default/security-policies/block-external&include_enforced_status=true\n",
"x-vmw-nsx-module": "PolicyRealizedState",
"x-vmw-nsx-example-response": "{\n \"consolidated_status\": {\n \"consolidated_status\": \"ERROR\"\n },\n \"consolidated_status_per_enforcement_point\": [\n {\n \"enforced_status\": {\n \"enforced_status_info\": {\n \"enforced_status\": {\n \"status\": \"UNKNOWN\"\n },\n \"enforced_status_per_scope\": [\n {\n \"enforced_status_per_transport_node\": [\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/c578e7ba-5ce5-11e9-acec-41d19997391c\",\n \"enforced_status\": {\n \"status\": \"FAILURE\",\n \"status_message\": \"Internal error(1101) occurred on transport node c578e7ba-5ce5-11e9-acec-41d19997391c.\"\n }\n },\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/a744cd7e-5ce5-11e9-a24b-df71fdc87f85\",\n \"enforced_status\": {\n \"status\": \"SUCCESS\"\n }\n },\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/77af8e10-5ce5-11e9-9149-5bb770f7c6c7\",\n \"enforced_status\": {\n \"status\": \"SUCCESS\"\n }\n },\n {\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/93ecd452-5ce5-11e9-8c18-bdce5885e998\",\n \"enforced_status\": {\n \"status\": \"SUCCESS\"\n }\n }\n ],\n \"resource_type\": \"TransportNodeSpanEnforcedStatus\"\n }\n ]\n },\n \"pending_changes_info\": {\n \"pending_changes_flag\": false\n }\n },\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"enforcement_point_id\": \"default\",\n \"consolidated_status\": {\n \"consolidated_status\": \"UNKNOWN\"\n }\n }\n ],\n \"intent_path\": \"/infra/domains/default/security-policies/block-external\"\n}\n"
}
},
"/global-infra/labels": {
"get": {
"tags": [
"Policy",
"Infra",
"Labels"
],
"summary": "List labels for infra",
"description": "Paginated list of all labels for infra.\n",
"operationId": "GlobalInfraListPolicyLabelForInfra",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLabelListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/labels\n",
"x-vmw-nsx-module": "PolicyLabel",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"type\": \"Domain\",\n \"refs\": [\n \"/infra/domains/mydomain3\",\n \"/infra/domains/mydomain2\",\n \"/infra/domains/mydomain1\"\n ],\n \"resource_type\": \"PolicyLabel\",\n \"id\": \"my-domains-label\",\n \"display_name\": \"my-domains-label\",\n \"path\": \"/infra/labels/my-domains-label\",\n \"relative_path\": \"my-domains-label\",\n \"parent_path\": \"/infra/labels/my-domains-label\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544641564432,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544641564432,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/pod-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given pod is a member",
"description": "Get policy groups for which the given pod is a member.\n",
"operationId": "GlobalInfraGetGroupsForContainerApplicationInstance",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "pod_id",
"in": "query",
"description": "ContainerApplicationInstance",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/pod-group-associations?pod_id=64dde333-15ac-de52-da90-974de459a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "List IDS rules",
"description": "List intrusion detection rules.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIdsRules",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"description": "Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp1/rules\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"action\": \"DETECT\",\n \"ids_profiles\": [\n \"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\"\n ],\n \"resource_type\": \"IdsRule\",\n \"id\": \"rule1\",\n \"display_name\": \"Test-Rule\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp1/rules/rule1\",\n \"relative_path\": \"rule1\",\n \"parent_path\": \"/infra/domains/default/intrusion-service-policies/sp1\",\n \"unique_id\": \"a22f5517-bdbf-45e7-a621-5fd50867eeea\",\n \"marked_for_delete\": false,\n \"sequence_number\": 100,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"/infra/domains/default/groups/Empty_Group\"\n ],\n \"destination_groups\": [\n \"/infra/domains/default/groups/Empty_Group\"\n ],\n \"logged\": true,\n \"scope\": [\n \"/infra/domains/default/groups/Empty_Group\"\n ],\n \"disabled\": true,\n \"direction\": \"OUT\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1563265736078,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1563265736082,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 4\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/segments/{segment-id}/effective-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "List all effective profiles for infra segment",
"description": "List all effective profiles for this segment on given enforcement point.",
"operationId": "ListInfraSegmentEffectiveProfiles",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectiveProfilesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/tier0-ls/effective-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/orgs/{org-id}/projects/{project-id}/aaa/role-bindings": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Get all users and groups with their roles",
"description": "Get all users and groups with their roles from CSP. If the root_path is\nprovided then only return role bindings that start-with or are\nsub-trees of the provided root path. Also filter the roles_for_paths\nsuch that only those roles_for_paths appear that start-with or are\nsub-tree of the provided root path.\n",
"operationId": "ListRoleBindingsMultitenancyProject",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_id",
"in": "query",
"description": "Identity source ID",
"schema": {
"type": "string"
}
},
{
"name": "identity_source_type",
"in": "query",
"description": "Identity source type",
"schema": {
"type": "string",
"enum": [
"VIDM",
"LDAP",
"OIDC"
]
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "User/Group name",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "path",
"in": "query",
"description": "Exact path of the context",
"schema": {
"type": "string"
}
},
{
"name": "role",
"in": "query",
"description": "Role ID",
"schema": {
"type": "string"
}
},
{
"name": "root_path",
"in": "query",
"description": "Prefix path of the context",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type",
"schema": {
"type": "string",
"enum": [
"remote_user",
"remote_group",
"local_user",
"principal_identity"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleBindingListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/aaa/role-bindings?page_size=2\n",
"x-vmw-nsx-module": "PolicyMultitenancyAuthorization",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"id\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"RoleBinding\",\n \"description\": \"\",\n \"id\": \"0395447b-480a-4091-9075-4070138e0cee\",\n \"display_name\": \"rt-group1\",\n \"roles\": [\n {\n \"role\": \"auditor\"\n }\n ],\n \"name\": \"rt-group1@abc.com\",\n \"type\": \"remote_group\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1493963048438,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1493963048438,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"RoleBinding\",\n \"description\": \"\",\n \"id\": \"7e672b0e-f0bd-48bc-b579-9e6f1b2b3969\",\n \"display_name\": \"johndoe@abc.com\",\n \"tags\": [],\n \"roles\": [\n {\n \"role\": \"enterprise_admin\"\n }\n ],\n \"name\": \"johndoe@abc.com\",\n \"type\": \"remote_user\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1493960803006,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1493960803006,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
},
"patch": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Roles"
],
"summary": "Assign roles to User or Group",
"description": "This API is used to assign a user/group any role(s) of choice on CSP.\nIt is recommended to use the new property roles_for_paths instead of\nroles. When using the roles_for_paths, set the read_roles_for_paths\nas true. User has union of all the roles assigned to it on a particular\npath and its sub-tree. User name is dealt case-insensitively.\n",
"operationId": "CreateOrUpdateRoleBindingMultitenancyProject",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleBinding"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleBinding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/orgs/default/projects/default/aaa/role-bindings\n{\n \"name\": \"johndoe@abc.com\",\n \"type\": \"remote_user\",\n \"read_roles_for_paths\": true,\n \"roles_for_paths\": [\n {\n \"path\": \"/orgs/default\",\n \"roles\": [\n {\n \"role\": \"org_admin\"\n }\n ]\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyMultitenancyAuthorization",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"RoleBinding\",\n \"description\": \"\",\n \"id\": \"7e672b0e-f0bd-48bc-b579-9e6f1b2b3969\",\n \"display_name\": \"johndoe@abc.com\",\n \"roles_for_paths\": [\n {\n \"path\": \"/orgs/default\",\n \"roles\": [\n {\n \"role\": \"org_admin\"\n }\n ]\n }\n ],\n \"name\": \"johndoe@abc.com\",\n \"type\": \"remote_user\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1493960803006,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1493960803006,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "RoleBinding"
}
},
"/infra/domains/{domain-id}/security-policies/{security-policy-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Revise the positioning of security policies",
"description": "This is used to set a precedence of a security policy w.r.t others.\n",
"operationId": "ReviseSecurityPolicies",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1?action=revise&anchor_path=/infra/domains/vmc/security-policies/emergency-section&operation=insert_before\n{\n \"description\": \"comm map revised\",\n \"display_name\": \"application-section-1\",\n \"category\":\"Application\",\n \"rules\": [\n {\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"action\": \"ALLOW\"\n }\n\n ]\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SecurityPolicy\",\n \"description\": \"comm map\",\n \"id\": \"application-section-1\",\n \"display_name\": \"application-section-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"application-section-1\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ],\n \"category\": \"Application\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 13000000,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317362027,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "SecurityPolicy"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/forwarding-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Routing",
"Forwarding Table"
],
"summary": "Get forwarding table from tier-1",
"description": "Get forwarding table from tier-1\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1ForwardingTable",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "component_type",
"in": "query",
"description": "Define the DR routes.",
"schema": {
"type": "string",
"enum": [
"DR_ROUTES"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_id",
"in": "query",
"description": "UUID of edge node",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "network_prefix",
"in": "query",
"description": "IPAddress or CIDR Block",
"schema": {
"type": "string",
"format": "address-or-cidr-block"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "route_source",
"in": "query",
"description": "Filter routes based on the source from which route is learned",
"schema": {
"type": "string",
"enum": [
"BGP",
"STATIC",
"CONNECTED",
"OSPF"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutingTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/mgw/forwarding-table\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"route_entries\": [\n\n {\n \"next_hop\": \"169.254.0.1\",\n \"route_type\": \"ns \",\n \"admin_distance\": 3,\n \"network\": \"25.1.0.0/16\"\n },\n {\n \"next_hop\": \"45.1.1.1\",\n \"route_type\": \"c \",\n \"admin_distance\": 0,\n \"network\": \"45.1.1.0/24\"\n },\n {\n \"next_hop\": \"169.254.0.1\",\n \"route_type\": \"ns \",\n \"admin_distance\": 3,\n \"network\": \"100.96.0.0/30\"\n },\n {\n \"next_hop\": \"169.254.0.2\",\n \"route_type\": \"c \",\n \"admin_distance\": 0,\n \"network\": \"169.254.0.0/28\"\n }\n ],\n \"count\": 4,\n \"edge_node\": \"41efeae8-58c2-11e8-993c-000c29326bac\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments"
],
"summary": "Get downlink port Address Resolution Protocol Proxies for tier-1 segment in CSV",
"description": "Returns ARP proxy table for downlink port on connected to the segment in CSV\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetDownlinkPortArpProxiesForTier1SegmentInCsv",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s//segments/test-segment/arp-proxy?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "TODO smanikarnike\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/firewall/policies": {
"get": {
"tags": [
"Policy",
"Security"
],
"summary": "Get policies filtered based on the given criteria",
"description": "Get the list of policies filtered based on the given criteria.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetFilteredPolicies",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "parent_path",
"in": "query",
"description": "Path of the parent object of the entities",
"schema": {
"type": "string"
}
},
{
"name": "scope",
"in": "query",
"description": "Scope filter criteria",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/firewall/policies?scope=6f1c310b-aeed-445e-aef9-9722c8967ab8&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1\",\n \"target_id\" : \"sp1\",\n \"target_type\" : \"SECURITY_POLICY\",\n \"is_valid\" : \"true\"\n },\n {\n \"path\" : \"/infra/domains/default/security-policies/sp2\",\n \"target_id\" : \"sp2\",\n \"target_type\" : \"SECURITY_POLICY\",\n \"is_valid\" : \"true\"\n }\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Statistics"
],
"summary": "Get gateway rule statistics",
"description": "Get statistics of a gateway rule.\n- no enforcement point path specified: Stats will be evaluated on each enforcement.\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "GetGatewayRuleStatistics",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/gateway-policies/emergency/rules/ce-1/statistics?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n {\n \"rule\": \"ce-1\",\n \"internal_rule_id\": \"1001\",\n \"packet_count\": 3806,\n \"session_count\": 819,\n \"hit_count\": 45,\n \"byte_count\": 322989,\n \"popularity_index\": 85,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n }\n ],\n \"cursor\" : 1,\n \"result_count\" : 1\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ip-pools": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "List IpAddressPools",
"description": "Paginated list of IpAddressPools.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIpAddressPools",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPoolListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-pools\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"IpAddressPool\",\n \"id\": \"IpPool-Tenant-1\",\n \"display_name\": \"IpPool-Tenant-1\",\n \"path\": \"/infra/ip-pools/IpPool-Tenant-1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"IpPool-Tenant-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/livetraces": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Livetrace"
],
"summary": "List livetrace config entities",
"description": "Get a paginated list of all livetrace config entities.\n",
"operationId": "ListLiveTraceConfig",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiveTraceConfigListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/livetraces\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"src_port_path\": \"/infra/segments/policy_segment/ports/default:0affc6ef-79b5-4a5b-9af8-d3046d101386\",\n \"actions\": {\n \"trace_config\": {\n \"sampling\": {\n \"match_number\": 1\n },\n \"trace_type\": \"UNI_DIRECTIONAL\"\n }\n },\n \"filter\": {\n \"resource_type\": \"FieldsFilterData\",\n \"ip_info\": {\n \"src_ip\": \"10.185.241.17/24\",\n \"dst_ip\": \"10.185.243.227/24\"\n },\n \"transport_info\": {\n \"protocol\": \"TCP\",\n \"src_port\": 16637,\n \"dst_port\": 80\n }\n },\n \"timeout\": 10,\n \"resource_type\": \"LiveTraceConfig\",\n \"id\": \"t01\",\n \"display_name\": \"t01\",\n \"path\": \"/infra/livetraces/t01\",\n \"relative_path\": \"t01\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"a83eb8a1-13bf-4742-8498-3cb796f96bfd\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1591173698390,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1591173698390,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Sessions"
],
"summary": "Get Tier-1 L2VPN session configuration for the peer site",
"description": "Get peer config for the Tier-1 L2VPN session to configure the remote\nside of the tunnel.\n- no enforcement point path specified: L2VPN Session Peer Codes\nwill be evaluated on each enforcement point.\n- enforcement point paths specified: L2VPN Session Peer Codes\nare evaluated only on the given enforcement points.\nAPI supported only when L2VPN Service is in Server Mode.\n\n
\nThis API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/\nsessions/<session-id>/peer-config instead.\nNote:\n The API will return a new VPN path for \"transport_tunnel_path\" in the response payload instead of the deprecated API path\n Both paths refer to the same object.\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n",
"operationId": "GetTier1L2VPNSessionPeerConfig",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateL2VPNSessionPeerConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/locale-services/default/l2vpn-services/default/sessions/streteched-pa-site/peer-config\n",
"x-vmw-nsx-module": "PolicyLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"l2vpn_session_path\": \"/infra/tier-1s/cgw/locale-services/default/l2vpn-services/default/sessions/streteched-pa-site\",\n \"peer_config_per_enforcement_point\": [\n {\n \"resource_type\": \"L2VPNSessionPeerCodes\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/nsxt\",\n \"peer_codes\": [\n {\n \"peer_code\": \"MCw0YTc2YTNlLHsic2l0ZU5hbWUiOiJwb2xpY3ktc2Vzc2lvbi1QUk9WSURFUi5obWl6YS5wYS1wdW5lLXJiLXZwbiIs\n InNyY1RhcElwIjoiMTY5LjI1NC42NC4yIiwiZHN0VGFwSXAiOiIxNjkuMjU0LjY0LjEiLCJpa2VPcHRpb24iOiJpa2V2\n MiIsImVuY2FwUHJvdG8iOiJncmUvaXBzZWMiLCJkaEdyb3VwIjoiZGgxNCIsImVuY3J5cHRBbmREaWdlc3QiOiJhZXMt\n Z2NtL3NoYS0yNTYiLCJwc2siOiJkZWZhdWx0IiwidHVubmVscyI6W3sibG9jYWxJZCI6IjI0LjI0LjI0LjI0IiwicGVl\n cklkIjoiMTEuMTEuMTEuMTEifV19\",\n \"transport_tunnel_path\": \"/infra/tier-1s/cgw/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1\"\n }\n ]\n }\n ]\n}\n"
}
},
"/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Get Mac Discovery Profile",
"description": "API will get Mac Discovery profile.\n",
"operationId": "GlobalInfraGetMacDiscoveryProfile",
"parameters": [
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n",
"x-vmw-nsx-module": "PolicyMacDiscovery",
"x-vmw-nsx-example-response": "{\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/mac-discovery-profiles/mdp1\",\n \"relative_path\": \"mdp1\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Update Mac Discovery Profile",
"description": "API will update Mac Discovery profile.\n",
"operationId": "GlobalInfraUpdateMacDiscoveryProfile",
"parameters": [
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n {\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1,\n \"_revision\": 1\n }\n",
"x-vmw-nsx-module": "PolicyMacDiscovery",
"x-vmw-nsx-example-response": "{\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"path\": \"/infra/mac-discovery-profiles/mdp1\",\n \"relative_path\": \"mdp1\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "MacDiscoveryProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Delete Mac Discovery Profile",
"description": "API will delete Mac Discovery profile.\n",
"operationId": "GlobalInfraDeleteMacDiscoveryProfile",
"parameters": [
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n",
"x-vmw-nsx-module": "PolicyMacDiscovery"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"MAC Discovery Profiles"
],
"summary": "Create Mac Discovery Profile",
"description": "API will create Mac Discovery profile.\n",
"operationId": "GlobalInfraCreateMacDiscoveryProfile",
"parameters": [
{
"name": "mac-discovery-profile-id",
"in": "path",
"description": "Mac Discovery Profile ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacDiscoveryProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/mac-discovery-profiles/mdp1\n {\n \"resource_type\":\"MacDiscoveryProfile\",\n \"display_name\": \"MacDiscoveryProfile\",\n \"description\": \"\",\n \"mac_change_enabled\": true,\n \"mac_learning_enabled\": true,\n \"unknown_unicast_flooding_enabled\": false,\n \"mac_limit_policy\": \"ALLOW\",\n \"mac_limit\": 1\n }\n",
"x-vmw-nsx-module": "PolicyMacDiscovery",
"x-codegen-request-body-name": "MacDiscoveryProfile"
}
},
"/infra/domains/{domain-id}/forwarding-policies": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies"
],
"summary": "List forwarding policies for the given domain",
"description": "List all forwarding policies for the given domain ordered by precedence.\n",
"operationId": "ListForwardingPolicies",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyForwarding"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/firewall-flood-protection-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "List Firewall Flood Protection Profile Binding Maps",
"description": "API will list all Firewall Flood Protection Profile Binding Maps in current group id.\n",
"operationId": "ListPolicyFirewallFloodProtectionBindings",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"binding-map-1\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallFloodProtectionProfileBindingMaps\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}/mirror-stack-status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "Get mirror stack status for Segment Monitoring Profile Binding Map",
"description": "API will get mirror stack status by Segment Monitoring Profile Binding Map.\n",
"operationId": "GetSegmentMonitoringBindingMirrorStackStatus",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-monitoring-profile-binding-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Binding map path enforcemnt point path to remote L3 mirror session",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MirrorStackStatusListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/segment-monitoring-profile-binding-maps/1/mirror-stack-status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding",
"x-vmw-nsx-example-response": "{\n \"overall_status\": \"FAILED\",\n \"results\": [\n {\n \"tn_node_name\": \"ESX1-VMW\",\n \"tn_node_id\": \"72b4e169-79d2-4b17-a7ad-9f5d5f8c2262\"\n \"dedicated_stack_status\": \"SUCCESS\",\n \"vmknic_status\": \"SUCCESS\"\n \"last_updated_time\": 1587636796387,\n \"detail\": \"Mirror stack and vmknic are healthy\"\n },\n {\n \"tn_node_name\": \"ESX2-VMW\",\n \"tn_node_id\": \"4b80de67-de55-4f00-97c6-d3342d4adcf6\"\n \"dedicated_stack_status\": \"SUCCESS\",\n \"vmknic_status\": \"FAILED\",\n \"last_updated_time\": 1587636796387,\n \"detail\": \"No vmknic\"\n }\n ],\n \"result_count\": 2\n}\n"
}
},
"/infra/identity-firewall-stores/{identity-firewall-store-id}/users": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"Users"
],
"summary": "List users by user name",
"description": "Return all the users based on the user name.",
"operationId": "ListUsersByUserName",
"parameters": [
{
"name": "identity-firewall-store-id",
"in": "path",
"description": "Firewall Identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "filter_value",
"in": "query",
"description": "Name search filter value",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityFirewallStoreUserOrGrouptListResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/identity-firewall-stores/idstore-1/users?filter_value=usr\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"resource_type\": \"DirectoryUser\",\n \"domain_id\": \"firewall-id-1\",\n \"domain_name\": \"DC=testad3,DC=local\",\n \"distinguished_name\": \"CN=usr1,OU=xyz,DC=testad3,DC=local\",\n \"id\": \"b2857fe5-c91e-4c59-a5e0-b8635aa8c4a9\",\n \"display_name\": \"usr1\",\n \"_create_time\": 1669790018212,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1669790018212,\n \"_last_modified_user\": \"system\",\n \"_system_owned\": false,\n \"_revision\": 0\n }\n ],\n \"result_count\": 1\n}\n"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/antrea-ip-pools": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get antrea ippools that belong to this Group",
"description": "Get antrea ippools that belong to this Group. This API is applicable for Groups\ncontaining AntreaIPPool member type. For\nGroups containing other member types an empty list is returned\n",
"operationId": "GetGroupAntreaIPPoolMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster_id",
"in": "query",
"description": "Cluster ID",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupAntreaIPPoolListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/antrea-ip-pools?cluster_id=6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"clusters\": [\n {\n \"external_id\": \"6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"ANTK01\",\n \"antrea_ip_pools\": [\n {\n \"external_id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"prod-ip-pool\",\n \"ip_ranges\": [\n {\n \"cidr\": \"10.10.1.0/28\",\n \"start\": \"10.10.1.0\",\n \"end\": \"10.10.1.15\",\n \"gateway\": \"10.10.1.0\",\n \"prefix_length\": 28,\n \"vlan\": 1\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n\"result_count\": 1,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Statistics"
],
"summary": "Get IPSec VPN session statistics under Tier-1",
"description": "- no enforcement point path specified: statistics are evaluated on each enforcement point.\n- an enforcement point path is specified: statistics are evaluated only on the given\nenforcement point.\n- source=realtime: statistics are fetched realtime from the enforcement point.\n- source=cached: cached statistics from enforcement point are returned.\n\n
\nThis API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/\nsessions/<session-id>/statistics instead.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1IPSecVpnSessionStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateIPSecVpnSessionStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1/statistics\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
},
"post": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Statistics"
],
"summary": "Reset the statistics of the given VPN session",
"description": "Resets the statistics of the given VPN session.\nSince source of data is enforcement point, data is\nreset there.\n\n
\nThis API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/\nsessions/<session-id>/statistics instead.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraResetTier1IPSecVpnSessionStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Action on statistics",
"required": true,
"schema": {
"type": "string",
"enum": [
"reset"
]
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-1s/ext_net/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1/statistics?action=reset\n",
"x-vmw-nsx-module": "PolicyVPNStatistics",
"x-vmw-nsx-example-response": ""
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"ARP Proxies"
],
"summary": "Get Tier-1 Interface Address Resolution Protocol Proxies",
"description": "Returns ARP proxy table for a tier-1 interface\n",
"operationId": "GetTier1InterfaceArpProxies",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyArpProxyTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://policy-mgr/policy/api/v1/infra/tier-1s/pepsi/locale-services/1-policyconnectivity-1340/interfaces/my-if/arp-proxy\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"interface_arp_proxy\" : [\n {\n \"service_id\" : \"0\",\n \"arp_proxy_ip\" : \"10.22.12.100\"\n }\n ]\n }\n ]\n}\n"
}
},
"/cluster/backups/history": {
"get": {
"tags": [
"System Administration",
"Lifecycle Management",
"Backup Restore Management",
"Backup"
],
"summary": "Get backup history",
"description": "Get history of previous backup operations\n",
"operationId": "GetBackupHistory",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupOperationHistory"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "BackupConfiguration",
"x-vmw-nsx-example-response": "{\n \"cluster_backup_statuses\": [\n {\n \"backup_id\" : \"2128af2d-d763-4a27-80e0-4933af7e4824-1462221358\",\n \"start_time\": 1523334840897,\n \"end_time\": 1523334916419,\n \"success\": true\n }\n ],\n \"node_backup_statuses\": [\n {\n \"backup_id\" : \"3128af2d-d763-4a27-80e0-4933af7e4824-1462221359\",\n \"start_time\": 1523411768398,\n \"end_time\": 1523411844682,\n \"success\": false,\n \"error_code\": \"BACKUP_SERVER_TIMEOUT\",\n \"error_message\": \"File server is not reachable, please check connectivity to file server\"\n }\n ],\n \"inventory_backup_statuses\": [\n {\n \"backup_id\" : \"4128af2d-d763-4a27-80e0-4933af7e4824-1462221360\",\n \"start_time\": 1523411625510,\n \"end_time\": 1523411701163,\n \"success\": true\n }\n ]\n}\n"
}
},
"/global-infra/sites/{site-id}": {
"get": {
"tags": [
"Federation",
"Sites"
],
"summary": "Read a site",
"description": "Read a site under Infra.\n",
"operationId": "GlobalInfraReadSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/casablanca\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Site\",\n \"id\": \"casablanca\",\n \"display_name\": \"Casablanca, Morocco Site\",\n \"description\" : \"Site managing call center workloads in North Africa\",\n \"path\": \"/infra/sites/casablanca\",\n \"parent_path\": \"/infra/sites/casablanca\",\n \"relative_path\": \"casablanca\",\n \"site_connection_info\": [{\n \"fqdn\": \"10.192.201.163\"\n }],\n \"maximum_rtt\": 250,\n \"fail_if_rtt_exceeded\": true,\n \"fail_if_mismatch_rteps\": true\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Interfaces"
],
"summary": "List Tier 1 Service Interfaces",
"description": "Paginated list of all Tier 1 Service Interfaces\n",
"operationId": "GlobalInfraListTier1ServiceInterfaces",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInterfaceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/service-interfaces\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"ServiceInterface\",\n \"id\": \"to_internet\",\n \"display_name\": \"to_internet\",\n \"path\": \"/infra/tier-1s/TLR1/locale-services/default/service-interfaces/to_internet\",\n \"parent_path\": \"/infra/tier-1s/TLR1/locale-services/default\",\n \"relative_path\": \"to_internet\",\n \"subnets\": [\n {\n \"ip_addresses\": [ \"35.1.1.1\" ],\n \"prefix_len\": 24\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516751318020,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516751318020,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Get IPSec VPN local endpoint",
"description": "Get IPSec VPN local endpoint for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "GetTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Create or fully replace IPSec VPN local endpoint",
"description": "Create or fully replace IPSec VPN local endpoint\nfor a given ipsec vpn service under Tier-1.\nRevision is optional for creation and required for update.\n",
"operationId": "CreateOrUpdateTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n{\n \"resource_type\": \"IPSecVpnLocalEndpoint\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_revision\": 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"path\" : \"/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "IPSecVpnLocalEndpoint"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Delete IPSec VPN local endpoint",
"description": "Delete IPSec VPN local endpoint for a ipsec vpn\nservice under Tier-1.\n",
"operationId": "DeleteTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Local Endpoints"
],
"summary": "Create or patch a custom IPSec VPN local endpoint",
"description": "Create or patch a custom IPSec VPN local endpoint for a given ipsec vpn service under Tier-1.",
"operationId": "CreateOrPatchTier1VpnIPSecVpnLocalEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "local-endpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnLocalEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/ipsec-vpn-services/default/local-endpoints/default-le\n{\n \"resource_type\" : \"IPSecVpnLocalEndpoint\",\n \"description\" : \"Local endpoint 1\",\n \"display_name\" : \"Local endpoint 1\",\n \"local_id\" : \"40.40.40.1\",\n \"local_address\" : \"40.40.40.1\"\n}\n",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-codegen-request-body-name": "IPSecVpnLocalEndpoint"
}
},
"/cluster?action=backup_to_remote": {
"post": {
"tags": [
"System Administration",
"Lifecycle Management",
"Backup Restore Management",
"Backup"
],
"summary": "Request one-time backup",
"description": "Request one-time backup. The backup will be uploaded using the\nsame server configuration as for automatic backup.\n",
"operationId": "RequestOnetimeBackup",
"parameters": [
{
"name": "frame_type",
"in": "query",
"description": "Frame type",
"schema": {
"type": "string",
"default": "LOCAL_LOCAL_MANAGER",
"enum": [
"GLOBAL_MANAGER",
"LOCAL_MANAGER",
"LOCAL_LOCAL_MANAGER",
"NSX_INTELLIGENCE"
]
}
},
{
"name": "site_id",
"in": "query",
"description": "Site ID",
"schema": {
"type": "string",
"default": "localhost"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/api/v1/cluster?action=backup_to_remote&site_id=fec18cee-ccf7-4d7c-bcc2-8634b08195cd&frame_type=LOCAL_MANAGER\n",
"x-vmw-nsx-module": "BackupConfiguration"
}
},
"/cluster/backups/status": {
"get": {
"tags": [
"System Administration",
"Lifecycle Management",
"Backup Restore Management",
"Backup"
],
"summary": "Get backup status",
"description": "Get status of active backup operations\n",
"operationId": "GetBackupStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrentBackupOperationStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "BackupConfiguration",
"x-vmw-nsx-example-response": "{\n \"operation_type\": \"backup\",\n \"backup_id\": \"fec18cee-ccf7-4d7c-bcc2-8634b08195cd-1523411326\",\n \"start_time\": 1523411326952,\n \"end_time\": 1523411628558,\n \"current_step\": \"BACKUP_CREATING_CLUSTER_BACKUP\"\n}\n"
}
},
"/infra/settings/firewall/stats?action=reset": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Statistics"
],
"summary": "Reset firewall rule statistics",
"description": "Sets firewall rule statistics counter to zero. This operation is supported\nfor given category, for example: DFW i.e. for all layer3 firewall\n(transport nodes only) rules or EDGE i.e. for all layer3 edge firewall\n(edge nodes only) rules.\n- no enforcement point path specified:\n On global manager, it is mandatory to give an enforcement point path.\n On local manager, reset of stats will be executed for each enforcement point.\n- {enforcement_point_path}: Reset of stats will be executed only for the given enforcement point.\n",
"operationId": "ResetRuleStats",
"parameters": [
{
"name": "category",
"in": "query",
"description": "Aggregation statistic category",
"required": true,
"schema": {
"type": "string",
"enum": [
"DFW",
"EDGE"
]
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "DfwSecurityPolicy"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/byod-service-instances/{service-instance-id}/service-instance-endpoints/{service-instance-endpoint-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-1 Gateways"
],
"summary": "Read Tier1 service instance endpoint",
"description": "Read Tier1 service instance endpoint",
"operationId": "ReadTier1PolicyServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Tier1 Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"ServiceInstanceEndpoint\",\n \"id\" : \"SIE_1\",\n \"display_name\" : \"SIE_1\",\n \"path\" : \"/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\",\n \"parent_path\" : \"/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1\",\n \"relative_path\" : \"SIE_1\",\n \"marked_for_delete\" : false,\n \"endpoint_type\" : \"LOGICAL\",\n \"target_ips\" : [ {\n \"ip_addresses\" : [ \"135.1.1.1\" ]\n } ],\n \"service_interface_path\" : \"/infra/tier-1s/TLR1/locale-services/default/service-interfaces/SITF_1\",\n \"_create_time\" : 1524826554351,\n \"_last_modified_user\" : \"admin\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_last_modified_time\" : 1524826554351,\n \"_create_user\" : \"admin\",\n \"_revision\" : 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-1 Gateways"
],
"summary": "Create Tier1 service instance endpoint",
"description": "Create Tier1 service instance endpoint with given request if not exist.\nModification of Tier1 service instance endpoint is not allowed.\n",
"operationId": "CreateTier1ServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Tier1 Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n{\n \"target_ips\": [\n {\n \"ip_addresses\": [ \"135.1.1.1\" ],\n \"prefix_length\": 24\n }\n ],\n\"endpoint_type\":\"LOGICAL\",\n\"service_interface_path\":\"/infra/tier-1s/TLR1/locale-services/default/service-interfaces/SITF_1\"\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"ServiceInstanceEndpoint\",\n \"id\" : \"SIE_1\",\n \"display_name\" : \"SIE_1\",\n \"path\" : \"/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\",\n \"parent_path\" : \"/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1\",\n \"relative_path\" : \"SIE_1\",\n \"marked_for_delete\" : false,\n \"endpoint_type\" : \"LOGICAL\",\n \"target_ips\" : [ {\n \"ip_addresses\" : [ \"135.1.1.1\" ]\n } ],\n \"service_interface_path\" : \"/infra/tier-1s/TLR1/locale-services/default/service-interfaces/SITF_1\",\n \"_create_time\" : 1524826554351,\n \"_last_modified_user\" : \"admin\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_last_modified_time\" : 1524826554351,\n \"_create_user\" : \"admin\",\n \"_revision\" : 0\n}\n",
"x-codegen-request-body-name": "ServiceInstanceEndpoint"
},
"delete": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-1 Gateways"
],
"summary": "Delete Tier1 service instance endpoint",
"description": "Delete Tier1 service instance endpoint",
"operationId": "DeleteTier1PolicyServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Tier1 Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n",
"x-vmw-nsx-module": "PolicyServiceInsertion"
},
"patch": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-1 Gateways"
],
"summary": "Create Tier1 service instance endpoint",
"description": "Create Tier1 Service instance endpoint.\n",
"operationId": "PatchTier1ServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Tier1 Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/TLR1/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n{\n \"target_ips\": [\n {\n \"ip_addresses\": [ \"135.1.1.1\" ],\n \"prefix_length\": 24\n }\n ],\n\"service_interface_path\":\"/infra/tier-1s/TLR1/locale-services/default/service-interfaces/SIE_1\"\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-codegen-request-body-name": "ServiceInstanceEndpoint"
}
},
"/infra/service-chains": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Chains"
],
"summary": "List service chains",
"description": "List all the service chains available for service insertion\n",
"operationId": "ListPolicyServiceChains",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyServiceChainListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/service-chains\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"forward_path_service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_1\",\n \"/infra/service-references/SR_1/service-profiles/SP_2\"\n ],\n \"reverse_path_service_profiles\": [\n \"/infra/service-references/SR_1/service-profiles/SP_2\",\n \"/infra/service-references/SR_1/service-profiles/SP_1\"\n ],\n \"service_segment_path\": [\n \"/infra/segments/service-segments/SS_1\"\n ],\n \"failure_policy\": \"ALLOW\",\n \"path_selection_policy\": \"ANY\",\n \"resource_type\": \"PolicyServiceChain\",\n \"id\": \"PSC_1\",\n \"display_name\": \"PSC_1\",\n \"description\": \"PSC_1 Desc\",\n \"path\": \"/infra/service-chains/PSC_1\",\n \"relative_path\": \"PSC_1\",\n \"parent_path\": \"/infra/service-chains/PSC_1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1546597502506,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1546597502506,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n],\n\"result_count\": 1,\n\"sort_by\": \"display_name\",\n\"sort_ascending\": true\n}\n"
}
},
"/global-infra/sha/pre-defined-plugins/{plugin-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Read Sha pre-defined plugin",
"description": "Read SHA pre-defined plugin.\n",
"operationId": "GlobalInfraReadShaPredefinedPlugin",
"parameters": [
{
"name": "plugin-id",
"in": "path",
"description": "Sha pre-defined plugin",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaPredefinedPlugin"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sha/pre-defined-plugins/daemon-health\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ShaPredefinedPlugin\",\n \"id\": \"6837ba7a-39cd-11eb-9f83-020068594730\",\n \"display_name\": \"System stats monitor plugin\",\n \"path\": /infra/sha/pre-defined-plugins/6837ba7a-39cd-11eb-9f83-020068594730\",\n \"parent_path\": \"/infra\",\n \"unique_id\" : \"88bf7bb8-02d6-4e93-8101-9f71841c5dfc\"\n \"relative_path\": \"88bf7bb8-02d6-4e93-8101-9f71841c5dfc\",\n \"enabled\": true,\n \"config\": {\n \"check_interval\": 20\n },\n \"node_type\":[\n \"NSX-EDGE\",\n \"NSX-MANAGER\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
}
},
"/infra/segments/{segment-id}/gateway-interface-dad-state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"DAD State"
],
"summary": "Get DAD state for downlink router port on tier-0 router",
"description": "Segment ID is the ID of the segment that is connected to the the tier-0\n",
"operationId": "GetDownlinkPortDadStateForInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceDADState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWNLINK_SWITCH/gateway-interface-dad-state\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_path\": \"/infra/segments/TIER0_DOWNLINK_SWITCH\",\n \"dad_statuses\": []\n}\n"
}
},
"/global-infra/transport-zone-profiles/{tz-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Transport Zone Profiles"
],
"summary": "Get Policy Transport Zone Profile",
"description": "API will fetch Policy Transport Zone Profile.\n",
"operationId": "GlobalInfraGetPolicyTransportZoneProfile",
"parameters": [
{
"name": "tz-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTransportZoneProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/transport-zone-profiles/tz-profile\n",
"x-vmw-nsx-module": "PolicyTransportZoneProfile",
"x-vmw-nsx-example-response": "{\n \"bfd_config\": {\n \"enabled\": true,\n \"probe_interval\": 500,\n \"latency_enabled\": false\n },\n \"tz_profile_type\": \"BFD\",\n \"resource_type\": \"PolicyTransportZoneProfile\",\n \"id\": \"tz-profile\",\n \"display_name\": \"PolicyTransportZoneProfile\",\n \"path\": \"/infra/transport-zone-profiles/tz-profile\",\n \"relative_path\": \"tz-profile\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"17288dbb-7138-4118-b1f0-701a52ca26d0\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1607658802371,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1607658802372,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/firewall/rules": {
"get": {
"tags": [
"Policy",
"Security"
],
"summary": "Get rules filtered based on the given criteria",
"description": "Get the list of rules of given parent path of policy/section, filtered\nbased on the given criteria.\nParent path is mandatory.\n",
"operationId": "GetFilteredRules",
"parameters": [
{
"name": "enforcement_point_path",
"in": "query",
"description": "Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "parent_path",
"in": "query",
"description": "Path of the parent object of the entities",
"schema": {
"type": "string"
}
},
{
"name": "scope",
"in": "query",
"description": "Scope filter criteria",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/firewall/rules?parent_path=/infra/domains/default/security-policies/sp1&scope=6f1c310b-aeed-445e-aef9-9722c8967ab8&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1/rules/rule1\",\n \"target_id\" : \"rule1\",\n \"target_type\" : \"RULE\",\n \"is_valid\" : \"true\"\n },\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1/rules/rule2\",\n \"target_id\" : \"rule2\",\n \"target_type\" : \"RULE\",\n \"is_valid\" : \"true\"\n }\n }\n ]\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/byod-service-instances/{service-instance-id}/service-instance-endpoints/{service-instance-endpoint-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-0 Gateways"
],
"summary": "Read service instance endpoint",
"description": "Read service instance endpoint",
"operationId": "ReadPolicyServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"ServiceInstanceEndpoint\",\n \"id\" : \"SIE_1\",\n \"display_name\" : \"SIE_1\",\n \"path\" : \"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\",\n \"parent_path\" : \"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1\",\n \"relative_path\" : \"SIE_1\",\n \"marked_for_delete\" : false,\n \"endpoint_type\" : \"LOGICAL\",\n \"target_ips\" : [ {\n \"ip_addresses\" : [ \"135.1.1.1\" ]\n } ],\n \"service_interface_path\" : \"/infra/tier-0s/vmc/locale-services/default/service-interfaces/SITF_1\",\n \"_create_time\" : 1524826554351,\n \"_last_modified_user\" : \"admin\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_last_modified_time\" : 1524826554351,\n \"_create_user\" : \"admin\",\n \"_revision\" : 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-0 Gateways"
],
"summary": "Create service instance endpoint",
"description": "Create service instance endpoint with given request if not exist.\nModification of service instance endpoint is not allowed.\n",
"operationId": "CreateServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n{\n \"target_ips\": [\n {\n \"ip_addresses\": [ \"135.1.1.1\" ],\n \"prefix_length\": 24\n }\n ],\n\"endpoint_type\":\"LOGICAL\",\n\"service_interface_path\":\"/infra/tier-0s/vmc/locale-services/default/service-interfaces/SITF_1\"\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"ServiceInstanceEndpoint\",\n \"id\" : \"SIE_1\",\n \"display_name\" : \"SIE_1\",\n \"path\" : \"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\",\n \"parent_path\" : \"/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1\",\n \"relative_path\" : \"SIE_1\",\n \"marked_for_delete\" : false,\n \"endpoint_type\" : \"LOGICAL\",\n \"target_ips\" : [ {\n \"ip_addresses\" : [ \"135.1.1.1\" ]\n } ],\n \"service_interface_path\" : \"/infra/tier-0s/vmc/locale-services/default/service-interfaces/SITF_1\",\n \"_create_time\" : 1524826554351,\n \"_last_modified_user\" : \"admin\",\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_last_modified_time\" : 1524826554351,\n \"_create_user\" : \"admin\",\n \"_revision\" : 0\n}\n",
"x-codegen-request-body-name": "ServiceInstanceEndpoint"
},
"delete": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-0 Gateways"
],
"summary": "Delete service instance endpoint",
"description": "Delete service instance endpoint",
"operationId": "DeletePolicyServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n",
"x-vmw-nsx-module": "PolicyServiceInsertion"
},
"patch": {
"tags": [
"Policy",
"Security",
"Service Insertion",
"Service Instances",
"Tier-0 Gateways"
],
"summary": "Create service instance endpoint",
"description": "Create Service instance endpoint.\n",
"operationId": "PatchServiceInstanceEndpoint",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"description": "Locale service id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-id",
"in": "path",
"description": "Service instance id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-instance-endpoint-id",
"in": "path",
"description": "Service instance endpoint id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInstanceEndpoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/byod-service-instances/BYOD_PSI_1/service-instance-endpoints/SIE_1\n{\n \"target_ips\": [\n {\n \"ip_addresses\": [ \"135.1.1.1\" ],\n \"prefix_length\": 24\n }\n ],\n\"service_interface_path\":\"/infra/tier-0s/vmc/locale-services/default/service-interfaces/SIE_1\"\n}\n",
"x-vmw-nsx-module": "PolicyServiceInsertion",
"x-codegen-request-body-name": "ServiceInstanceEndpoint"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/attributes": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "List Policy L7 access profile supported attributes and sub-attributes",
"description": "Returns supported attribute and sub-attributes for specified\nattribute key with their supported values, if provided in query/request\nparameter, else will fetch all supported attributes and sub-attributes for\nall supported attribute keys.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListL7AccessProfileProfileSupportedAttributes",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attribute_key",
"in": "query",
"description": "Fetch attributes and sub-attributes for the given attribute key",
"schema": {
"type": "string"
}
},
{
"name": "attribute_source",
"in": "query",
"description": "Source of the attribute, System Defined or custom",
"schema": {
"type": "string",
"default": "SYSTEM",
"enum": [
"ALL",
"CUSTOM",
"SYSTEM"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/l7-access-profiles/attributes\n",
"x-vmw-nsx-module": "L7AccessProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\": [\n \"SSL\"\n ],\n \"datatype\":\"STRING\",\n \"description\":\"SSL (Secure Sockets Layer) is a cryptographic protocol that provides security over the Internet.\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V10\",\n \"TLS_V11\",\n \"TLS_V12\",\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\",\n \"SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA\",\n ]\n \"datatype\":\"STRING\"\n }\n ],\n },\n {\n \"key\":\"DOMAIN_NAME\",\n \"value\": [\n \"*.office365.com\"\n ],\n \"datatype\":\"STRING\",\n \"description\":\"Office 365 url\"\n }\n ]\n }\n ]\n}\n"
}
},
"/global-infra/ipv6-ndra-profiles/{ndra-profile-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"IPV6 NDRA Profiles"
],
"summary": "Read IPv6 NDRA profile",
"description": "Read IPv6 NDRA profile",
"operationId": "GlobalInfraReadIpv6NdraProfile",
"parameters": [
{
"name": "ndra-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ipv6NdraProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipv6-ndra-profiles/ra1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"ra_mode\": \"SLAAC_DNS_THROUGH_RA\",\n \"ra_config\": {\n \"ra_interval\": 400,\n \"hop_limit\": 64,\n \"router_lifetime\": 1800,\n \"prefix_lifetime\": 2592000,\n \"prefix_preferred_time\": 604800\n },\n \"dns_config\": {\n \"domain_name\": [],\n \"domain_name_lifetime\": 1800000,\n \"dns_server\": [],\n \"dns_server_lifetime\": 1800000\n },\n \"reachable_timer\": 0,\n \"retransmit_interval\": 0,\n \"resource_type\": \"Ipv6NdraProfile\",\n \"id\": \"ra1\",\n \"display_name\": \"ra1\",\n \"path\": \"/infra/ipv6-ndra-profiles/ra1\",\n \"relative_path\": \"ra1\",\n \"parent_path\": \"/infra/ipv6-ndra-profiles/ra1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1553898363040,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1553898441728,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"IPV6 NDRA Profiles"
],
"summary": "Create or update IPv6 NDRA profile",
"description": "If profile with the ndra-profile-id is not already present,\ncreate a new IPv6 NDRA profile instance. If it already exists, replace\nthe IPv6 NDRA profile instance with this object.\n",
"operationId": "GlobalInfraCreateOrReplaceIpv6NdraProfile",
"parameters": [
{
"name": "ndra-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ipv6NdraProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ipv6NdraProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/ipv6-ndra-profiles/ra1\n{\n \"ra_mode\": \"SLAAC_DNS_THROUGH_RA\",\n \"ra_config\": {\n \"ra_interval\": 600,\n \"hop_limit\": 64,\n \"router_lifetime\": 1800,\n \"prefix_lifetime\": 2592000,\n \"prefix_preferred_time\": 604800\n },\n \"dns_config\": {\n \"domain_name\": [],\n \"domain_name_lifetime\": 1800000,\n \"dns_server\": [],\n \"dns_server_lifetime\": 1800000\n },\n \"reachable_timer\": 0,\n \"retransmit_interval\": 0,\n \"resource_type\": \"Ipv6NdraProfile\",\n \"id\": \"ra1\",\n \"display_name\": \"ra1\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"ra_mode\": \"SLAAC_DNS_THROUGH_RA\",\n \"ra_config\": {\n \"ra_interval\": 600,\n \"hop_limit\": 64,\n \"router_lifetime\": 1800,\n \"prefix_lifetime\": 2592000,\n \"prefix_preferred_time\": 604800\n },\n \"dns_config\": {\n \"domain_name\": [],\n \"domain_name_lifetime\": 1800000,\n \"dns_server\": [],\n \"dns_server_lifetime\": 1800000\n },\n \"reachable_timer\": 0,\n \"retransmit_interval\": 0,\n \"resource_type\": \"Ipv6NdraProfile\",\n \"id\": \"ra1\",\n \"display_name\": \"ra1\",\n \"path\": \"/infra/ipv6-ndra-profiles/ra1\",\n \"relative_path\": \"ra1\",\n \"parent_path\": \"/infra/ipv6-ndra-profiles/ra1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1553898363040,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1553898363040,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "Ipv6NdraProfile"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"IPV6 NDRA Profiles"
],
"summary": "Delete IPv6 NDRA profile",
"description": "Delete IPv6 NDRA profile",
"operationId": "GlobalInfraDeleteIpv6NdraProfile",
"parameters": [
{
"name": "ndra-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/ipv6-ndra-profiles/ra1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"IPV6 NDRA Profiles"
],
"summary": "Create or update IPv6 NDRA profile",
"description": "If profile with the ndra-profile-id is not already present,\ncreate a new IPv6 NDRA profile instance. If it already exists, update\nthe IPv6 NDRA profile instance with specified attributes.\n",
"operationId": "GlobalInfraPatchIpv6NdraProfile",
"parameters": [
{
"name": "ndra-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ipv6NdraProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ipv6-ndra-profiles/ra1\n{\n \"ra_mode\": \"SLAAC_DNS_THROUGH_RA\",\n \"ra_config\": {\n \"ra_interval\": 400,\n \"hop_limit\": 64,\n \"router_lifetime\": 1800,\n \"prefix_lifetime\": 2592000,\n \"prefix_preferred_time\": 604800\n },\n \"dns_config\": {\n \"domain_name\": [],\n \"domain_name_lifetime\": 1800000,\n \"dns_server\": [],\n \"dns_server_lifetime\": 1800000\n },\n \"reachable_timer\": 0,\n \"retransmit_interval\": 0,\n \"resource_type\": \"Ipv6NdraProfile\",\n \"id\": \"ra1\",\n \"display_name\": \"ra1\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "Ipv6NdraProfile"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Security",
"N-S Firewall"
],
"summary": "List N-S Firewall Rules",
"description": "List N-S Firewall Rules\nGET /orgs/org1/projects/project1/vpcs/vpc-1/gateway-policies/default/rules\n",
"operationId": "ListVpcGatewayRules",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default/rules\n",
"x-vmw-nsx-module": "PolicyVpcGatewayPolicy",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"action\": \"ALLOW\",\n \"resource_type\": \"Rule\",\n \"id\": \"default-public-ip\",\n \"display_name\": \"ORG-default PROJECT-project-1 VPC-vpc-1 default-public-ip\",\n \"description\": \"default rule to allow outgoing traffic from the public subnets\",\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default/rules/default-public-ip\",\n \"relative_path\": \"default-public-ip\",\n \"parent_path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default\",\n \"remote_path\": \"\",\n \"unique_id\": \"00000000-0000-0000-0000-000000001014\",\n \"realization_id\": \"00000000-0000-0000-0000-000000001014\",\n \"owner_id\": \"e1f5ef8a-21b7-48d1-9117-22797c2ea2dc\",\n \"origin_site_id\": \"e1f5ef8a-21b7-48d1-9117-22797c2ea2dc\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"rule_id\": 1014,\n \"sequence_number\": 2147483647,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"/orgs/default/projects/project-1/vpcs/vpc-1/groups/default-public-ip-group\"\n ],\n \"destination_groups\": [\n \"ANY\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"profiles\": [\n \"ANY\"\n ],\n \"logged\": false,\n \"disabled\": false,\n \"direction\": \"IN_OUT\",\n \"ip_protocol\": \"IPV4_IPV6\",\n \"is_default\": true,\n \"_create_time\": 1668778432233,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1668778432233,\n \"_last_modified_user\": \"system\",\n \"_system_owned\": false,\n \"_revision\": 0\n },\n {\n \"action\": \"DROP\",\n \"resource_type\": \"Rule\",\n \"id\": \"default\",\n \"display_name\": \"ORG-default PROJECT-project-1 VPC-vpc-1 default\",\n \"path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default/rules/default\",\n \"relative_path\": \"default\",\n \"parent_path\": \"/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default\",\n \"remote_path\": \"\",\n \"unique_id\": \"00000000-0000-0000-0000-000000001015\",\n \"realization_id\": \"00000000-0000-0000-0000-000000001015\",\n \"owner_id\": \"e1f5ef8a-21b7-48d1-9117-22797c2ea2dc\",\n \"origin_site_id\": \"e1f5ef8a-21b7-48d1-9117-22797c2ea2dc\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"rule_id\": 1015,\n \"sequence_number\": 2147483647,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"ANY\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"profiles\": [\n \"ANY\"\n ],\n \"logged\": false,\n \"disabled\": false,\n \"direction\": \"IN_OUT\",\n \"ip_protocol\": \"IPV4_IPV6\",\n \"is_default\": true,\n \"_create_time\": 1668778432235,\n \"_create_user\": \"system\",\n \"_last_modified_time\": 1668778432235,\n \"_last_modified_user\": \"system\",\n \"_system_owned\": false,\n \"_revision\": 0\n }\n ],\n \"result_count\": 2,\n \"sort_by\": \"sequence_number\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Get Segment QoS Profile Binding Map",
"description": "API will get Segment QoS Profile Binding Map.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/segments/segment_1/segment-qos-profile-binding-maps/1\",\n \"relative_path\": \"SegmentQoSProfileBindingMaps\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Update Segment QoS Profile Binding Map",
"description": "API will update Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateInfraSegmentQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-qos-profile-binding-maps/1\n{\n \"resource_type\":\" SegmentQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"description\":\"\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SegmentQoSProfileBindingMap\",\n \"description\": \"\",\n \"display_name\":\"1\",\n \"id\":\"1\",\n \"path\": \"/infra/segments/segment_1/segment-qos-profile-binding-maps/1\",\n \"relative_path\": \"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "SegmentQoSProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Delete Segment QoS Profile Binding Profile",
"description": "API will delete Segment QoS Profile Binding Profile.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteInfraSegmentQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-qos-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"QOS Profile Binding"
],
"summary": "Create Segment QoS Profile Binding Map",
"description": "API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchInfraSegmentQoSBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-qos-profile-binding-map-id",
"in": "path",
"description": "Segment QoS Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentQoSProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/segments/segment_1/segment-qos-profile-binding-maps/1\n{\n \"resource_type\":\" SegmentQoSProfileBindingMap\",\n \"display_name\":\"1\",\n \"qos_profile_path\":\"/infra/qos_profiles/1\"\n}\n",
"x-vmw-nsx-module": "PolicyQoSProfileBinding",
"x-codegen-request-body-name": "SegmentQoSProfileBindingMap"
}
},
"/search/query": {
"get": {
"tags": [
"Search",
"Search API"
],
"summary": "Full text search API",
"description": "Full text search API",
"operationId": "QuerySearch",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "query",
"in": "query",
"description": "Search query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/search/query?query=resource_type:group&page_size=2\nGET https://<nsx-mgr>/policy/api/v1/search/query?query=resource_type:group&page_size=2\nGET https://<nsx-mgr>/global-manager/api/v1/search/query?query=resource_type:group&page_size=2\n",
"x-vmw-nsx-module": "Search",
"x-vmw-nsx-example-response": "{\n\"results\": [\n {\n \"_last_modified_user\": \"admin\",\n \"_revision\": 4,\n \"_system_owned\": false,\n \"resource_type\": \"Group\",\n \"description\": \"Prod Env Group\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_last_modified_time\": 1561700732921,\n \"display_name\": \"ProdEnvGroup\",\n \"_create_user\": \"admin\",\n \"tags\": [\n {\n \"scope\": \"Prod\",\n \"tag\": \"Group\"\n }\n ],\n \"_create_time\": 1561614698915,\n \"path\": \"/infra/domains/default/groups/4fc8c310-989f-11e9-baf3-930b233a84c6\",\n \"marked_for_delete\": false,\n \"parent_path\": \"/infra/domains/default\",\n \"id\": \"4fc8c310-989f-11e9-baf3-930b233a84c6\",\n \"relative_path\": \"4fc8c310-989f-11e9-baf3-930b233a84c6\",\n \"status\": {\n \"consolidated_status_per_enforcement_point\": [\n {\n \"consolidated_status\": {\n \"consolidated_status\": \"SUCCESS\"\n },\n \"enforcement_point_id\": \"default\"\n }\n ],\n \"consolidated_status\": {\n \"consolidated_status\": \"SUCCESS\"\n },\n \"intent_path\": \"/infra/domains/default/groups/4fc8c310-989f-11e9-baf3-930b233a84c6\"\n }\n },\n {\n \"_last_modified_user\": \"admin\",\n \"_revision\": 0,\n \"_system_owned\": false,\n \"resource_type\": \"Group\",\n \"description\": \"DevOps Environment Group\",\n \"_protection\": \"NOT_PROTECTED\",\n \"_last_modified_time\": 1561707088516,\n \"display_name\": \"DevOpsEnvGroup\",\n \"_create_user\": \"admin\",\n \"tags\": [\n {\n \"scope\": \"DevOps\",\n \"tag\": \"Group\"\n }\n ],\n \"_create_time\": 1561707088516,\n \"path\": \"/infra/domains/default/groups/DevOpsEnvGroup\",\n \"marked_for_delete\": false,\n \"parent_path\": \"/infra/domains/default\",\n \"id\": \"DevOpsEnvGroup\",\n \"relative_path\": \"DevOpsEnvGroup\",\n \"status\": {\n \"consolidated_status_per_enforcement_point\": [\n {\n \"consolidated_status\": {\n \"consolidated_status\": \"SUCCESS\"\n },\n \"enforcement_point_id\": \"default\"\n }\n ],\n \"consolidated_status\": {\n \"consolidated_status\": \"SUCCESS\"\n },\n \"intent_path\": \"/infra/domains/default/groups/DevOpsEnvGroup\"\n }\n }\n],\n\"result_count\": 3,\n\"cursor\": \"2\"\n}\n"
}
},
"/infra/port-mirroring-profiles": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Port Mirroring"
],
"summary": "List Port Mirroring Profiles",
"description": "API will list all port mirroring profiles group.\n",
"operationId": "ListPortMirroringProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortMirroringProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles\n",
"x-vmw-nsx-module": "PolicyPortMirroring",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortMirroringProfile\",\n \"id\": \"session_2\",\n \"display_name\": \"/infra/port-mirroring-profiles\",\n \"path\": \"/infra/port-mirroring-profiles/session_2\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"session_2\",\n \"snap_length\": 744,\n \"destination_group\": \"/infra/domains/d1/groups/group_ip\",\n \"direction\": \"BIDIRECTIONAL\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353633527,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/segments/{segment-id}/gateway-interface-arp-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table for downlink router port on tier-0 router",
"description": "Get ARP table for downlink router port on tier-0 router.\n
\nThis API is deprecated because it is duplicate.\nPlease use /infra/segments/<segment-id>/arp-table\nSegment ID is the ID of the segment that is connected to the the tier-0\n",
"operationId": "GetDownlinkPortArpTableForInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWNLINK_SWITCH/gateway-interface-arp-table?edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/7f7d37a7-b78e-4378-949d-09190cbfef7d/edge-nodes/a831390e-a7c8-11ea-9102-020063e79023\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"interface_path\": \"/infra/realized-state/enforcement-points/default/logical-ports/TLR0_LR-TIER0_DOWNLINK_SWITCH-dlrp\",\n \"last_update_timestamp\": 1591854345080,\n \"results\": [\n {\n \"mac_address\": \"00:0c:29:ad:24:e4\",\n \"ip\": \"192.168.100.163\"\n },\n {\n \"mac_address\": \"00:00:00:00:00:00\",\n \"ip\": \"192.168.100.161\"\n },\n {\n \"mac_address\": \"00:00:00:00:00:00\",\n \"ip\": \"192.168.100.160\"\n }\n ],\n \"result_count\": 3,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/deployment-zones": {
"get": {
"tags": [
"Policy",
"Infra",
"Deployment Zones"
],
"summary": "List Deployment Zones for infra",
"description": "Paginated list of all Deployment zones for infra.\n\n
\nThis is a deprecated API. DeploymentZone has been renamed to Site.\nUse GET /infra/sites.\n",
"operationId": "ListDeploymentZonesForInfra",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentZoneListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-module": "PolicyEnforcementPointManagement"
}
},
"/global-infra/cloud-native-service-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given Cloud Native Service Instance is a member",
"description": "Get policy groups for which the given Cloud Native Service Instance is a member.\n",
"operationId": "GlobalInfraGetGroupsForCloudNativeServiceInstance",
"parameters": [
{
"name": "cns_external_id",
"in": "query",
"description": "Cloud Native Service external ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/cloud-native-service-group-associations?cns_external_id=564de333-15ac-de52-da90-974fe099a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/global-infra/crls/{crl-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certification Revocation List"
],
"summary": "Show CRL Data for the Given CRL id.",
"description": "Returns information about the specified CRL. For additional information,\ninclude the ?details=true modifier at the end of the request URI.\n",
"operationId": "GlobalInfraGetTlsCrl",
"parameters": [
{
"name": "crl-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "whether to expand the pem data and show all its details",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCrl"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/crls/revokedCerts?details=true\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"TlsCrl\",\n \"display_name\": \"revoked certificates\",\n \"path\": \"/infra/crls/revokedCerts\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"revokedCerts\",\n \"pem_encoded\": \"-----BEGIN X509 CRL----------END X509 CRL-----\\n\",\n \"details\": {\n \"next_update\": \"945220365000\",\n \"issuer\": \"1.2.840.113549.1.9.1=#161d726f6f744069676c6f6f2e6974732e756e696d656c622e6564752e6175,CN=igloo Certificate Authority,OU=Certificates Administration,O=igloo CA,L=Melbourne,ST=Victoria,C=AU\",\n \"version\": \"1\"\n },\n \"crl_type\": \"X509\",\n \"unique_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"realization_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1413387436438,\n \"_create_time\": 1413386249116,\n \"_create_user\": \"admin\"\n}\n"
}
},
"/global-infra/virtual-machine-group-associations": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get groups for which the given VM is a member",
"description": "Get policy groups for which the given VM is a member.\n",
"operationId": "GlobalInfraGetGroupsForVM",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "vm_external_id",
"in": "query",
"description": "Virtual machine external ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/virtual-machine-group-associations?vm_external_id=564de333-15ac-de52-da90-974fe099a17b&enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/domain1/groups/g1\",\n \"target_id\" : \"g1\",\n \"target_display_name\" : \"group-1\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n },\n {\n \"path\" : \"/infra/domains/domain1/groups/g2\",\n \"target_id\" : \"g2\",\n \"target_display_name\" : \"group-2\",\n \"target_type\" : \"DOMAIN_GROUP\",\n \"is_valid\" : \"true\",\n \"owner_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\",\n \"origin_site_id\": \"4c5c5516-087a-47cd-9fba-a7669775d308\"\n }\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/effective-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports"
],
"summary": "List all effective profiles for infra segment port",
"description": "List all effective profiles for this segment port on given enforcement point.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListInfraSegmentPortsEffectiveProfiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectiveProfilesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/tier0-ls/port/p1/effective-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"DAD State"
],
"summary": "Get DAD status by interface",
"description": "Get tier-1 interface DAD state information.\n",
"operationId": "GlobalInfraGetTier1InterfaceDADState",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceDADState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/pepsi/locale-services/default/interfaces/to_internet/dad-state?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_path\": \"/infra/tier-1s/pepsi/locale-services/default/interfaces/to_internet\",\n \"dad_statuses\": [\n {\n \"ip_address\": \"2001::1\",\n \"status\": \"ASSIGNED\",\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-point/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd/edge-nodes/940f1f4b-0317-45d4-84e2-b8c2394e7405\"\n ]\n }\n ]\n}\n"
}
},
"/global-infra/segments/{segment-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "Read infra segment",
"description": "Read infra segment\nNote:\nExtended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the\n\"l2_extension\" object in the PATCH API payload, the path returned in the GET response payload may include the new path\ninstead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.\nAlso note that l2vpn path included in the error messages returned from validation may include the new VPN path\ninstead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.\n",
"operationId": "GlobalInfraReadInfraSegment",
"parameters": [
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web-tier\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Segment\",\n \"id\": \"web-tier\",\n \"display_name\": \"web-tier\",\n \"path\": \"/infra/tier-1s/cgw/segments/web-tier\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [\n \"40.1.2.0/24\"\n ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668961954,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668961954,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Route Maps"
],
"summary": "Read a route map",
"description": "Read a route map",
"operationId": "GlobalInfraGetRouteMap",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "route-map-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0RouteMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/route-maps/rm1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"RoueMap\",\n \"id\": \"rm1\",\n \"display_name\": \"rm1\",\n \"path\": \"/infra/tier-0s/vmc_prv/route-maps/rm1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"rm1\",\n \"entries\": [\n {\n \"community_list_matches\": [\n {\n \"criteria\": \"/infra/tier-0s/vmc/community-lists/cl1\",\n \"match_operator\": \"MATCH_ALL\"\n }],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n },\n {\n \"prefix_list_matches\": [ \"/infra/tier-0s/vmc/prefix-lists/pl1\" ],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/global-infra/labels/{label-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Labels"
],
"summary": "Read lable",
"description": "Read a label.\n",
"operationId": "GlobalInfraReadPolicyLabelForInfra",
"parameters": [
{
"name": "label-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyLabel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/labels/my-domains-label\n",
"x-vmw-nsx-module": "PolicyLabel",
"x-vmw-nsx-example-response": "{\n \"type\": \"Domain\",\n \"refs\": [\n \"/infra/domains/mydomain3\",\n \"/infra/domains/mydomain2\",\n \"/infra/domains/mydomain1\"\n ],\n \"resource_type\": \"PolicyLabel\",\n \"id\": \"my-domains-label\",\n \"display_name\": \"my-domains-label\",\n \"path\": \"/infra/labels/my-domains-label\",\n \"relative_path\": \"my-domains-label\",\n \"parent_path\": \"/infra/labels/my-domains-label\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544641564432,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544641564432,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/global-infra/domains/{domain-id}/groups/{group-id}/members/logical-ports": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get logical ports that belong to this Group",
"description": "Get logical ports that belong to this Group\nThis API is applicable for Groups containing either VirtualMachine, VIF,\nSegment or Segment Port member type.For Groups containing other\nmember types,an empty list is returned.\n",
"operationId": "GlobalInfraGetGroupLPMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/logical-ports?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n \"id\" : \"20c1ac1f-58b5-4241-a352-f8e82c4a8c65\",\n \"display_name\" : \"LP-HR1\"\n },\n {\n \"id\" : \"c07005fe-4a9a-47f1-9a1e-2db65a285124\",\n \"display_name\" : \"LP-HR2\"\n }\n ]\n}\n"
}
},
"/global-infra/crls": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certification Revocation List"
],
"summary": "Return All Added CRLs",
"description": "Returns information about all CRLs. For additional information, include the\n?details=true modifier at the end of the request URI.\n",
"operationId": "GlobalInfraListTlsCrls",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "whether to expand the pem data and show all its details",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "node_id",
"in": "query",
"description": "Node ID of certificate to return",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type of certificate to return",
"schema": {
"type": "string",
"enum": [
"cluster_api_certificate",
"api_certificate"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCrlListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/crls?details=true\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"TlsCrl\",\n \"display_name\": \"revoked certificates\",\n \"path\": \"/infra/crls/revokedCerts\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"revokedCerts\",\n \"pem_encoded\": \"-----BEGIN X509 CRL----------END X509 CRL-----\\n\",\n \"details\": {\n \"next_update\": \"945220365000\",\n \"issuer\": \"1.2.840.113549.1.9.1=#161d726f6f744069676c6f6f2e6974732e756e696d656c622e6564752e6175,CN=igloo Certificate Authority,OU=Certificates Administration,O=igloo CA,L=Melbourne,ST=Victoria,C=AU\",\n \"version\": \"1\"\n },\n \"crl_type\": \"X509\",\n \"unique_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"realization_id\": \"511cf9cd-448b-4fa5-9bdf-a24a9dcba853\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1413387436438,\n \"_create_time\": 1413386249116,\n \"_create_user\": \"admin\"\n },\n {\n \"crl_type\": \"OneCRL\",\n \"one_crl\": \"{\\\"data\\\":[ <...> ]}\",\n \"details_revoked_by_issuer_and_serial_number\": [ <...> ],\n \"details_revoked_by_subject_and_public_key_hash\": [ <...> ],\n \"resource_type\": \"TlsCrl\",\n \"id\": \"default_public_crl\",\n \"display_name\": \"default_public_crl\",\n \"path\": \"/infra/crls/default_public_crl\",\n \"relative_path\": \"default_public_crl\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"91503436-5215-4d13-93e0-094c7473e30d\",\n \"realization_id\": \"91503436-5215-4d13-93e0-094c7473e30d\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1630097138768,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1630107914252,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n },\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/ports/{port-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"Statistics"
],
"summary": "Get infra segment port statistics information",
"description": "Get infra segment port statistics information.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentPortStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/tier0-ls-2/ports/ls2-p1/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"rx_packets\": {\n \"total\": 0\n },\n \"rx_bytes\": {\n \"total\": 0\n },\n \"tx_packets\": {\n \"total\": 0\n },\n \"tx_bytes\": {\n \"total\": 0\n },\n \"logical_port_id\": \"706aecff-7741-4856-bc9b-d96fbcf474b8\"\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/l2vpn-services": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Get L2VPN service list result under Tier-0",
"description": "Get paginated list of all L2VPN services under Tier-0.",
"operationId": "ListTier0VpnL2VPNServices",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/l2vpn-services\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"result_count\" : 1,\n \"results\" : [ {\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-0s/ext_net/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/routing-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Routing Table"
],
"summary": "Get routing table from tier-0",
"description": "Get routing table from tier-0\n",
"operationId": "GlobalInfraGetTier0Routes",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "component_type",
"in": "query",
"description": "Define the DR routes.",
"schema": {
"type": "string",
"enum": [
"DR_ROUTES"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_id",
"in": "query",
"description": "UUID of edge node",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "network_prefix",
"in": "query",
"description": "IPAddress or CIDR Block",
"schema": {
"type": "string",
"format": "address-or-cidr-block"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "route_source",
"in": "query",
"description": "Filter routes based on the source from which route is learned",
"schema": {
"type": "string",
"enum": [
"BGP",
"STATIC",
"CONNECTED",
"OSPF"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoutingTableListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/routing-table\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"route_entries\": [\n\n {\n \"next_hop\": \"169.254.0.1\",\n \"route_type\": \"ns \",\n \"admin_distance\": 3,\n \"network\": \"25.1.0.0/16\"\n },\n {\n \"next_hop\": \"45.1.1.1\",\n \"route_type\": \"c \",\n \"admin_distance\": 0,\n \"network\": \"45.1.1.0/24\"\n },\n {\n \"next_hop\": \"169.254.0.1\",\n \"route_type\": \"ns \",\n \"admin_distance\": 3,\n \"network\": \"100.96.0.0/30\"\n },\n {\n \"next_hop\": \"169.254.0.2\",\n \"route_type\": \"c \",\n \"admin_distance\": 0,\n \"network\": \"169.254.0.0/28\"\n }\n ],\n \"count\": 4,\n \"edge_node\": \"41efeae8-58c2-11e8-993c-000c29326bac\"\n }\n ]\n}\n"
}
},
"/infra/segments": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments"
],
"summary": "List all segments under infra",
"description": "Paginated list of all segments under infra.\n",
"operationId": "ListAllInfraSegments",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "segment_type",
"in": "query",
"description": "Segment type",
"schema": {
"type": "string",
"enum": [
"DVPortgroup",
"ALL"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Segment\",\n \"id\": \"web-tier\",\n \"display_name\": \"web-tier\",\n \"path\": \"/infra/segments/web-tier\",\n \"parent_path\": \"/infra/segments/web-tier\",\n \"relative_path\": \"web-tier\",\n \"subnets\": [\n {\n \"gateway_address\": \"40.1.1.1/16\",\n \"dhcp_ranges\": [\n \"40.1.2.0/24\"\n ]\n }\n ],\n \"connectivity_path\": \"/infra/tier-1s/mgw\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668961954,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668961954,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/certificates": {
"get": {
"tags": [
"Policy",
"Infra",
"Certificates",
"Certificates"
],
"summary": "Return All the User-Facing Components' Certificates",
"description": "Returns all certificate information viewable by the user, including each\ncertificate's id; pem_encoded data; and history of the\ncertificate (who created or modified it and when). For additional\ninformation, include the ?details=true modifier at the end of the request\nURI.\n",
"operationId": "GlobalInfraListTlsCertificates",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "whether to expand the pem data and show all its details",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "node_id",
"in": "query",
"description": "Node ID of certificate to return",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Type of certificate to return",
"schema": {
"type": "string",
"enum": [
"cluster_api_certificate",
"api_certificate"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsCertificateList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/certificates\n",
"x-vmw-nsx-module": "PolicyCertificate",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"TlsCertificate\",\n \"id\": \"caCert\",\n \"display_name\": \"caCert\",\n \"path\": \"/infra/certificates/caCert\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"caCert\",\n \"details\": [ ... ],\n \"pem_encoded\": \"-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n\",\n \"has_private_key\": false,\n \"tls_certificate_type\": \"CERTIFICATE_CA\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516329725649,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516329725649,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"TlsCertificate\",\n \"id\": \"selfSignedCert\",\n \"display_name\": \"selfSignedCert\",\n \"path\": \"/infra/certificates/selfSignedCert\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"selfSignedCert\",\n \"details\": [\n {\n \"issuer_cn\": \"vSM Test Certificate\",\n \"public_key_length\": 1024,\n \"signature\": \"4e cf ff 36 ac a1\",\n \"not_before\": 1323772715000,\n \"subject\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"serial_number\": \"ca55f5e21a0b2dd2\",\n \"public_key_algo\": \"RSA\",\n \"version\": \"1\",\n \"issuer\": \"1.2.840.113549.1.9.1=#16076140622e636f6d,CN=vSM Test Certificate,OU=vShield,O=VMware,L=Pune,ST=Maharashtra,C=IN\",\n \"is_ca\": false,\n \"subject_cn\": \"vSM Test Certificate\",\n \"not_after\": 1355308715000,\n \"is_valid\": false,\n \"rsa_public_key_exponent\": \"10001\",\n \"signature_algorithm\": \"SHA1WITHRSA\",\n \"rsa_public_key_modulus\": \"00 b7 8f 79 e4\"\n }\n ],\n \"pem_encoded\": \"-----BEGIN CERTIFICATE----------END CERTIFICATE-----\\n\",\n \"has_private_key\": true,\n \"tls_certificate_type\": \"CERTIFICATE_SELF_SIGNED\",\n \"unique_id\": \"e523b4c0-c3c5-4656-80a1-36dd0fab38cb\",\n \"realization_id\": \"e523b4c0-c3c5-4656-80a1-36dd0fab38cb\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516338671237,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516338671237,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/lb-persistence-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer Persistence Profiles"
],
"summary": "List LBPersistenceProfiles for infra",
"description": "Paginated list of all LBPersistenceProfiles for infra.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "ListLBPersistenceProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBPersistenceProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/lb-persistence-profiles\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 3,\n \"results\": [\n {\n \"resource_type\": \"LBCookiePersistenceProfile\",\n \"id\": \"cookieSharedPersistence\",\n \"display_name\": \"/infra/lb-persistence-profiles/cookieSharedPersistence\",\n \"path\": \"/infra/lb-persistence-profiles/cookieSharedPersistence\",\n \"parent_path\": \"/infra/lb-persistence-profiles/cookieSharedPersistence\",\n \"relative_path\": \"cookieSharedPersistence\",\n \"cookie_name\": \"NSXLB\",\n \"cookie_mode\": \"INSERT\",\n \"cookie_fallback\": true,\n \"cookie_garble\": true,\n \"persistence_shared\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516320262166,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516320262166,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"LBCookiePersistenceProfile\",\n \"id\": \"default-cookie-lb-persistence-profile\",\n \"display_name\": \"/infra/lb-persistence-profiles/default-cookie-lb-persistence-profile\",\n \"path\": \"/infra/lb-persistence-profiles/default-cookie-lb-persistence-profile\",\n \"parent_path\": \"/infra/lb-persistence-profiles/default-cookie-lb-persistence-profile\",\n \"relative_path\": \"default-cookie-lb-persistence-profile\",\n \"cookie_name\": \"NSXLB\",\n \"cookie_mode\": \"INSERT\",\n \"cookie_fallback\": true,\n \"cookie_garble\": true,\n \"persistence_shared\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516320253128,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516320253128,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"LBSourceIpPersistenceProfile\",\n \"id\": \"default-source-ip-lb-persistence-profile\",\n \"display_name\": \"/infra/lb-persistence-profiles/default-source-ip-lb-persistence-profile\",\n \"path\": \"/infra/lb-persistence-profiles/default-source-ip-lb-persistence-profile\",\n \"parent_path\": \"/infra/lb-persistence-profiles/default-source-ip-lb-persistence-profile\",\n \"relative_path\": \"default-source-ip-lb-persistence-profile\",\n \"purge\": \"FULL\",\n \"timeout\": 300,\n \"persistence_shared\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516320265151,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516320265151,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/ipsec-vpn-ike-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"IKE Profiles"
],
"summary": "List IKE profiles",
"description": "Get paginated list of all IKE Profiles.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListIPSecVpnIkeProfiles",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecVpnIkeProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ipsec-vpn-ike-profiles",
"x-vmw-nsx-module": "PolicyVpnIPSecVpn",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n \"resource_type\" : \"IPSecVpnIkeProfile\",\n \"path\": \"/infra/ipsec-vpn-ike-profiles/aws-ike-profile\",\n \"encryption_algorithms\" : [ \"AES_128\" ],\n \"ike_version\" : \"IKE_V1\",\n \"digest_algorithms\" : [ \"SHA2_256\" ],\n \"sa_life_time\" : 86400,\n \"dh_groups\" : [ \"GROUP14\" ],\n \"_create_time\" : 1517289492627,\n \"_last_modified_user\" : \"system\",\n \"_last_modified_time\" : 1517289492627,\n \"_system_owned\" : false,\n \"_create_user\" : \"system\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n } ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/quota-stats": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"Quota"
],
"summary": "Get quota details",
"description": "Get quota details\nTo create, update, list and delete the Quota, please refer to Constraint APIs with 'constraint_expressions'\nas 'EntityInstanceCountConstraintExpression'.\n",
"operationId": "GetQuotaDetails",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "constraint_path",
"in": "query",
"description": "Constraint path to retrive the quota details.",
"schema": {
"type": "string"
}
},
{
"name": "path_prefix",
"in": "query",
"description": "Path prefix for retriving the quota details.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotaStatsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/quota-stats?path_prefix=/orgs/org-1/projects/project-1\n&constraint_path=/orgs/org-1/projects/project-1/infra/constraints/quota-1\n",
"x-vmw-nsx-module": "PolicyMultiTenancyQuota",
"x-vmw-nsx-example-response": "{\n \"results\": [{\n \"object_type\": \"Group\",\n \"quota_name\": \"Quota 1\",\n \"current_inventory\": 500,\n \"assigned_max_limit\": 1000\n }, {\n \"object_type\": \"Vpc\",\n \"quota_name\": \"Quota 1\",\n \"current_inventory\": 50,\n \"assigned_max_limit\": 100\n }]\n}\n"
}
},
"/infra/sha/dynamic-runbooks/{runbook-id}/help": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Online Diagnostic System"
],
"summary": "Read help information of a Dynamic Runbook",
"description": "Read help information of an Online Diagnostic System Dynamic Runbook.\n",
"operationId": "LoadOdsDynamicRunbookHelpInfo",
"parameters": [
{
"name": "runbook-id",
"in": "path",
"description": "Identifier of a Dynamic Runbook",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OdsRunbookHelpInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/sha/dynamic-runbooks/0000004f-7665-726c-6179-54756e6e656c/help\n",
"x-vmw-nsx-module": "PolicyOds",
"x-vmw-nsx-example-response": "{\n \"summary\" : \"An example runbook for demonstration purpose.\",\n \"parameter_info\" : [ {\n \"summary\" : \"Parameters for the dynamic runbook\",\n \"parameter\" : {\n \"name\" : \"org\",\n \"optional\" : false,\n \"parameter_type\" : \"string\"\n }\n }]\n}\n"
}
},
"/infra/alb-onboarding-workflow/{managed-by}": {
"delete": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Alb Onboarding Workflow"
],
"summary": "Delete EnforcementPoint and the Infra Admin credentials contained by this workflow",
"description": "Delete the EnforcementPoint along with Infra Admin credentials.\n",
"operationId": "DeleteAlbOnBoardingWorkflow",
"parameters": [
{
"name": "managed-by",
"in": "path",
"description": "On Boarding flow managed by LCM/VCF.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/alb-onboarding-workflow/LCM\n",
"x-vmw-nsx-module": "PolicyALBControllerOnBoarding",
"x-vmw-nsx-example-response": "200 OK"
}
},
"/orgs/{org-id}/projects/{project-id}/aaa/user-info": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"Users"
],
"summary": "Get the name and role information of the user.",
"description": "This API will return the name and role information of the user\ninvoking this API request on the particular project.\nThe permissions parameter of the NsxRole has been deprecated.\nThe response will contain the roles_for_paths to indicate roles\nof the user at various paths .\n",
"operationId": "GetMultitenantCurrentUserInfo",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/org/default/projects/project-1/aaa/user-info\n",
"x-vmw-nsx-module": "PolicyMultitenancyAuthorization",
"x-vmw-nsx-example-response": "{\n \"user_name\": \"johndoe@abc.com\",\n \"roles_for_paths\": [\n {\n \"path\": \"/orgs/default/projects/project-1\",\n \"roles\": [\n {\n \"role\": \"security_engineer\",\n \"role_display_name\": \"Security Admin\"\n }\n ]\n }\n ]\n}\n"
}
},
"/malware-prevention/teaser/registration_url": {
"post": {
"tags": [
"Management Plane API",
"Security",
"Malware Prevention"
],
"summary": "Registration URL",
"description": "Registration URL.",
"operationId": "CreateMalwarePreventionTeaserRegistrationUrl",
"parameters": [
{
"name": "region",
"in": "query",
"description": "Region",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MalwarePreventionTeaserRegistrationURL"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/malware-prevention/teaser/registration_url\n",
"x-vmw-nsx-module": "NsxMalwarePreventionTeaser",
"x-vmw-nsx-example-response": "{\n\"registration_url\":\"https://nsx.west.us.lastline.com/register-vcf-sandbox-trial?q=eyJsaWNlbnNlcyI6IFsiNEY4M0YtTUpTWUctN0g2T1UtQzA5MUctVzNGTlIiLCAiV0lYV0UtTjNRUTMtUjlIU08tMFVPTkYtTVBQTU4iXSwgInRzIjogMTcxODEyNDAwOCwgInV1aWQiOiAiYWFlN2JlNzctNzllMS00N2UyLTkyY2ItOWU2OGZlNmY5N2NhIn0%3D\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/span": {
"get": {
"tags": [
"Federation",
"Sites"
],
"summary": "Get span for an entity with specified path",
"description": "Get span for an entity with specified path.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetSpan",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "intent_path",
"in": "query",
"description": "String Path of the intent object",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "site_path",
"in": "query",
"description": "Policy Path of the site",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Span"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<global-manager>/global-manager/api/v1/global-infra/span?intent_path=/global-infra/tier-0s/t0\n",
"x-vmw-nsx-module": "PolicySitesSpan",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"SPAN\",\n \"span_resource_type\": \"PROVIDER\",\n \"span_resource\": \"/global-infra/tier-0s/t0\",\n \"span_leader\": \"/global-infra/tier-0s/t0\",\n \"site_ids\": [\n \"51a1294a-b1d5-40a9-a382-2b1aeb62c41a\",\n \"3d497d3f-2f9a-4983-9db0-d1f5f7cbc3d0\"\n ],\n \"marked_for_delete\": false,\n \"overridden\": false\n}\n"
}
},
"/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "List Infra Port Discovery Profile Binding Maps",
"description": "API will list all Infra Port Discovery Profile Binding Maps in current port id.\n",
"operationId": "ListInfraPortDiscoveryBindings",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "infra-port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/dhcp-server-configs/{config-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Server Configs"
],
"summary": "Read DHCP server status",
"description": "Read DHCP server status",
"operationId": "GlobalInfraReadDhcpServerStatus",
"parameters": [
{
"name": "config-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "connectivity_path",
"in": "query",
"description": "String Path of Tier0, Tier1 or Segment",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpServerStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/status?connectivity_path=/infra/tier-1s/it_t1&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"active_node\": \"/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/bf80b020-2df8-11ea-986b-000c291ec83c\",\n \"stand_by_node\": \"/infra/sites/default/enforcement-points/default/edge-clusters/43436d79-05ce-4c0b-b31f-078989d4e6fd/edge-nodes/c03dadec-2df8-11ea-a4e6-000c295fbd46\",\n \"service_status\": \"UP\"\n}\n"
}
},
"/global-infra/flood-protection-profiles/{flood-protection-profile-id}/bindings": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profiles"
],
"summary": "List Flood Protection Profiles",
"description": "API will list all Flood Protection Profiles bindings.",
"operationId": "GlobalInfraListFloodProtectionProfileBindings",
"parameters": [
{
"name": "flood-protection-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloodProtectionProfileBindingListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/flood-protection-profiles/profile-1/bindings\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"FloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"name\": \"default\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tier-0s/my-t0/flood-protection-profile-bindings/default\",\n \"relative_path\": \"default\",\n \"profile_path\" : \"/infra/flood-protection-profiles/profile-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Network Services",
"NAT"
],
"summary": "GET Policy NAT types.",
"description": "Get either of the two supported sections (USER and NAT64) under the given VPC ID.\nThe USER section allows IPV4 based NAT rules, while the NAT64 rules allow\ntranslating IPV6 packets to IPV4 packets.\nFor more details related to NAT section please refer to PolicyNAT schema.\n",
"operationId": "GetPolicyNatOnVpc",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "nat-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyNat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/vpcs/vpc1/nat/USER\n",
"x-vmw-nsx-module": "PolicyVpcNat",
"x-vmw-nsx-example-response": "{\n \"nat_type\": \"USER\",\n \"resource_type\": \"PolicyNat\",\n \"id\": \"USER\",\n \"display_name\": \"USER\",\n \"path\": \"/orgs/org1/projects/project1/vpcs/vpc1/nat/USER\",\n \"relative_path\": \"USER\",\n \"parent_path\": \"/orgs/org1/projects/project1/vpcs/vpc1\",\n \"unique_id\": \"202e658c-17bd-41bb-bc72-bfdef716ba9b\",\n \"realization_id\": \"202e658c-17bd-41bb-bc72-bfdef716ba9b\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_system_owned\": true,\n \"_create_time\": 1633385644755,\n \"_create_user\": \"admin\",\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1633385644755,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/services/{service-id}/service-entries/{service-entry-id}": {
"get": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Service entry",
"description": "Service entry",
"operationId": "OrgsOrgIdProjectsProjectIdInfraReadServiceEntry",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-entry-id",
"in": "path",
"description": "Service entry ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceEntry"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/services/my-http/service-entries/https\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"https\",\n \"display_name\": \"MyHttps\",\n \"path\": \"/infra/services/my-http/service-entries/https\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"https\",\n \"destination_ports\": [\n \"7443\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517316057383,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517316057383,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Create or update a ServiceEntry",
"description": "If a service entry with the service-entry-id is not already present,\ncreate a new service entry. If it already exists, update the service\nentry.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdateServiceEntry",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-entry-id",
"in": "path",
"description": "Service entry ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceEntry"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceEntry"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/services/my-http/service-entries/https\n{\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"display_name\": \"MyHttps\",\n \"destination_ports\": [\n \"7443\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"https\",\n \"display_name\": \"MyHttps\",\n \"path\": \"/infra/services/my-http/service-entries/https\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"https\",\n \"destination_ports\": [\n \"7443\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517316057383,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517316057383,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "ServiceEntry"
},
"delete": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Delete Service entry",
"description": "Delete Service entry",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteServiceEntry",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-entry-id",
"in": "path",
"description": "Service entry ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/services/my-http/service-entries/https\n",
"x-vmw-nsx-module": "Policy"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Patch a ServiceEntry",
"description": "If a service entry with the service-entry-id is not already present,\ncreate a new service entry. If it already exists, patch the service\nentry.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchServiceEntry",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-entry-id",
"in": "path",
"description": "Service entry ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceEntry"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/services/my-http/service-entries/https\n{\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"display_name\": \"MyHttps\",\n \"destination_ports\": [\n \"9443\"\n ],\n \"l4_protocol\": \"TCP\"\n}\n",
"x-vmw-nsx-module": "Policy",
"x-codegen-request-body-name": "ServiceEntry"
}
},
"/infra/settings/firewall/export?action=download": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Task"
],
"summary": "Download exported file",
"description": "Download the exported file generated from the last export task. The request\nshould have proper headers set to download the file. Please add the below\ntwo headers, if it is not already present\nAccept application/json, text/plain, */*\nAccept-Encoding gzip, deflate, br\n",
"operationId": "DownloadExportedFile",
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export?action=download\n",
"x-vmw-nsx-module": "PolicyTask",
"x-vmw-nsx-example-response": "zipped file containing the exported configuration in CSV format.\n"
}
},
"/infra/segments/{segment-id}/arp-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from segment interface (downlink)",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the\ninterface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge\nnode specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "GetInfraSegmentInterfaceArpTable",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/web-app-seg/arp-table?enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"displayName\",\n \"result_count\": 3,\n \"interface_path\": \"/infra/realized-state/enforcement-points/default/logical-ports/infra-web-app-seg-dlrp\",\n \"enforcement_point_path\": \"/infra/sites/default/enforcement-points/default\",\n \"edge_path\": \"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\",\n example_response: |\n \"results\": [\n {\n \"mac_address\": \"00:50:56:8e:b4:21\",\n \"ip\": \"172.16.10.21\"\n },\n {\n \"mac_address\": \"02:50:56:56:44:52\",\n \"ip\": \"172.16.10.1\"\n },\n {\n \"mac_address\": \"00:50:56:8e:91:12\",\n \"ip\": \"172.16.10.11\"\n }\n ]\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"Status"
],
"summary": "Get segment port status information",
"description": "Get tier1 segment port status information.\n",
"operationId": "GlobalInfraGetSegmentPortStatus",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1//infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:cf3a0716-3ba0-4327-a8e5-b1e76269108f/status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_port_id\": \"04efc498-b872-40fc-83f8-ebf9317a2766\",\n \"last_update_timestamp\": 1453764613211,\n \"status\": \"UP\"\n}\n"
}
},
"/infra/livetraces/{livetrace-id}/status": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Livetrace"
],
"summary": "Read livetrace status",
"description": "Read status for a livetrace config with the specified identifier.\n",
"operationId": "ReadLiveTraceStatus",
"parameters": [
{
"name": "livetrace-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiveTraceStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/livetraces/t01/status\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"id\": \"/infra/livetraces/t01\",\n \"source_lport\": \"/infra/segments/policy_segment/ports/default:0affc6ef-79b5-4a5b-9af8-d3046d101386\",\n \"operation_state\": \"FINISHED\",\n \"timeout\": 10,\n \"filter\": {\n \"ip_info\": {\n \"src_ip\": \"10.185.241.17/24\",\n \"dst_ip\": \"10.185.243.227/24\"\n },\n \"transport_info\": {\n \"protocol\": \"TCP\",\n \"src_port\": 16637,\n \"dst_port\": 80\n },\n \"resource_type\": \"FieldsFilterData\"\n },\n \"actions\": {\n \"trace_config\": {\n \"sampling_argument\": {\n \"sampling_type\": \"FirstNSampling\",\n \"match_number\": 1\n },\n \"trace_type\": \"UNI_DIRECTIONAL\"\n }\n },\n \"request_status\": \"SUCCESS_DELIVERED\",\n \"_protection\": \"NOT_PROTECTED\"\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"DAD State"
],
"summary": "Get DAD status by interface",
"description": "Get tier-1 interface DAD state information.\n",
"operationId": "GetTier1InterfaceDADState",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceDADState"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/pepsi/locale-services/default/interfaces/to_internet/dad-state?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_path\": \"/infra/tier-1s/pepsi/locale-services/default/interfaces/to_internet\",\n \"dad_statuses\": [\n {\n \"ip_address\": \"2001::1\",\n \"status\": \"ASSIGNED\",\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-point/nsx/edge-clusters/95196903-6b8a-4276-a7c4-387263e834fd/edge-nodes/940f1f4b-0317-45d4-84e2-b8c2394e7405\"\n ]\n }\n ]\n}\n"
}
},
"/infra/firewall-identity-store-ldap-server": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store",
"LDAP Servers"
],
"summary": "Test a directory domain LDAP server connectivity",
"description": "This API tests a LDAP server connectivity before the actual domain or LDAP server is configured. If the connectivity is good, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.",
"operationId": "VerifyFirewallIdentityStoreLdapServer",
"parameters": [
{
"name": "action",
"in": "query",
"description": "LDAP server test requested",
"required": true,
"schema": {
"type": "string",
"enum": [
"CONNECTIVITY"
]
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServer"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryLdapServerStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-store-ldap-server?action=CONNECTIVITY\n{\n \"domain_name\": \"nimbustest.com\",\n \"username\": \"dummy\",\n \"password\": \"dummy\",\n \"host\": \"10.161.34.143\",\n \"display_name\": \"nimbus LDAP\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"port\": 389,\n \"protocol\": \"LDAP\"\n}\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"error_id\": 38519,\n \"error_message\": \"LDAP server 1.1.1.1 connection failed during verification.\"\n}\n",
"x-codegen-request-body-name": "DirectoryLdapServer"
}
},
"/global-infra/services": {
"get": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "List Services for infra",
"description": "Paginated list of Services for infra.\n",
"operationId": "GlobalInfraListServicesForTenant",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "default_service",
"in": "query",
"description": "Fetch all default services",
"schema": {
"type": "boolean"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/services\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 402,\n \"results\": [\n {\n \"resource_type\": \"Service\",\n \"description\": \"AD Server\",\n \"id\": \"AD_Server\",\n \"display_name\": \"AD Server\",\n \"path\": \"/infra/services/AD_Server\",\n \"parent_path\": \"/infra/services/AD_Server\",\n \"relative_path\": \"AD_Server\",\n \"service_entries\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"AD_Server\",\n \"display_name\": \"AD Server\",\n \"path\": \"/infra/services/AD_Server/service-entries/AD_Server\",\n \"parent_path\": \"/infra/services/AD_Server\",\n \"relative_path\": \"AD_Server\",\n \"destination_ports\": [\n \"1024\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"system\",\n \"_create_time\": 1517296380484,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1517296380484,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"_create_user\": \"system\",\n \"_create_time\": 1517296380468,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1517296380468,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n }\n"
}
},
"/infra/settings/firewall/security/intrusion-services/pcaps/export": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Profiles"
],
"summary": "Request the IDS Pcap File Download",
"description": "Trigger the process to collect all pcap files of all the pcap_ids mentioned in request payload.\n",
"operationId": "ExportIdsPcapFile",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsPcapExport"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/api/v1/infra/settings/firewall/security/intrusion-services/pcaps/export\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-codegen-request-body-name": "IdsPcapExport"
}
},
"/infra/context-profiles/custom-attributes/default": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Retrieves custom attribute values for given attribute key",
"description": "This API lists all the custom attribute values defined in the system for the attribute_key\nmentioned as part of the url.\n",
"operationId": "GetCustomAttribute",
"parameters": [
{
"name": "attribute_key",
"in": "query",
"description": "Fetch attributes and sub-attributes for the given attribute key",
"schema": {
"type": "string"
}
},
{
"name": "attribute_source",
"in": "query",
"description": "Source of the attribute, System Defined or custom",
"schema": {
"type": "string",
"default": "SYSTEM",
"enum": [
"ALL",
"CUSTOM",
"SYSTEM"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes/default?attribute_key=DOMAIN_NAME\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.office365.com\", \"*.azure.com\"\n ],\n \"datatype\":\"STRING\"\n}\n"
},
"post": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Adds/Removes custom attribute values from list",
"description": "This API adds/removes custom attribute values from list for a given attribute key. The values in the \nrequest will be added or removed from the existing list.\n",
"operationId": "AddRemoveCustomAttribute",
"parameters": [
{
"name": "action",
"in": "query",
"description": "Add or Remove Custom Context Profile Attribute values.",
"required": true,
"schema": {
"type": "string",
"enum": [
"add",
"remove"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyCustomAttributes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes/default?action=add\n{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.customdomainname5.com\", \"*.customdomainname6.com\"\n ],\n \"datatype\":\"STRING\"\n }\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "200 OK\n",
"x-codegen-request-body-name": "PolicyCustomAttributes"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Update custom attribute value list for given attribute key.",
"description": "This API updates custom attribute value list for given key in the request. This replaces the \nexisting list with the list provided in the request\n",
"operationId": "PatchCustomAttribute",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyCustomAttributes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/context-profiles/custom-attributes/default\n{\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.customdomainname1.com\", \"*.customdomainname2.com\"\n ],\n \"datatype\":\"STRING\"\n }\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-vmw-nsx-example-response": "200 OK\n",
"x-codegen-request-body-name": "PolicyCustomAttributes"
}
},
"/infra/domains": {
"get": {
"tags": [
"Policy",
"Infra",
"Domains",
"Domain"
],
"summary": "List domains for infra",
"description": "Paginated list of all domains for infra.\n",
"operationId": "ListDomainForInfra",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Domain\",\n \"description\": \"VMC Domain\",\n \"id\": \"vmc\",\n \"display_name\": \"VMC domain\",\n \"path\": \"/infra/domains/vmc\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"vmc\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517307910473,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517307910473,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/alb-auth-token": {
"put": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Alb Auth Token"
],
"summary": "Alb Auth Token API calls to Avi Controller.",
"description": "Passthorugh API calls to Avi controller using the Auth of policy API\nrequest send to this API will be passthrough to Avi controller and\nAvi controller response will be embedded for this API.\n",
"operationId": "GetALBAuthToken",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBAuthToken"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBAuthToken"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "{\n \"username\" : \"nsxt-alb\",\n \"hours\" : \"5\"\n}\n",
"x-vmw-nsx-module": "PolicyALBControllerOnBoarding",
"x-vmw-nsx-example-response": "{\n \"token\": \"ca632c40a19ab7b124f57ee4f3972433165fab57\",\n \"expires_at\": \"2021-08-06T00:37:30.116Z\"\n}\n",
"x-codegen-request-body-name": "ALBAuthToken"
}
},
"/global-infra/tier-0s/{tier-0-id}/routing-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Routing Table"
],
"summary": "Get routing table from tier-0 in CSV format",
"description": "Get routing table from tier-0 gateway in CSV format.\n",
"operationId": "GlobalInfraGetTier0RoutesCsv",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "component_type",
"in": "query",
"description": "Define the DR routes.",
"schema": {
"type": "string",
"enum": [
"DR_ROUTES"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_id",
"in": "query",
"description": "UUID of edge node",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "network_prefix",
"in": "query",
"description": "IPAddress or CIDR Block",
"schema": {
"type": "string",
"format": "address-or-cidr-block"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "route_source",
"in": "query",
"description": "Filter routes based on the source from which route is learned",
"schema": {
"type": "string",
"enum": [
"BGP",
"STATIC",
"CONNECTED",
"OSPF"
]
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/GatewayRouteTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/routing-table?format=csv\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "route_type,network,interface,next_hop,admin_distance,lr_component_id,lr_component_type\nNSX_INTERNAL,0.0.0.0/0,/infra/tier-0s/t0/locale-services/default/interfaces/public1,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nNSX_INTERNAL,100.64.1.0/31,,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nNSX_INTERNAL,100.64.1.1/32,,169.0.0.2,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,169.0.0.0/28,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,172.16.10.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,1l72.16.20.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\nCONNECTED,172.16.30.0/24,,0.0.0.0,0,\"875381be-a4c5-4173-8aa7-ab71695a8129\",DISTRIBUTED_ROUTER\n"
}
},
"/infra/lb-client-ssl-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer SSL Profiles",
"Load Balancer Client SSL Profiles"
],
"summary": "List LBClientSslProfiles",
"description": "Paginated list of all LBClientSslProfiles.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "ListLBClientSslProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBClientSslProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/lb-client-ssl-profiles\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 3,\n \"results\": [\n {\n \"cipher_group_label\": \"BALANCED\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"session_cache_timeout\": 300,\n \"prefer_server_ciphers\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBClientSslProfile\",\n \"id\": \"default-balanced-client-ssl-profile\",\n \"display_name\": \"default-balanced-client-ssl-profile\",\n \"path\": \"/infra/lb-client-ssl-profiles/default-balanced-client-ssl-profile\",\n \"relative_path\": \"default-balanced-client-ssl-profile\",\n \"parent_path\": \"/infra/lb-client-ssl-profiles/default-balanced-client-ssl-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1543304450941,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1543304450941,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0 },\n {\n \"cipher_group_label\": \"HIGH_COMPATIBILITY\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"session_cache_timeout\": 300,\n \"prefer_server_ciphers\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBClientSslProfile\",\n \"id\": \"default-high-compatibility-client-ssl-profile\",\n \"display_name\": \"default-high-compatibility-client-ssl-profile\",\n \"path\": \"/infra/lb-client-ssl-profiles/default-high-compatibility-client-ssl-profile\",\n \"relative_path\": \"default-high-compatibility-client-ssl-profile\",\n \"parent_path\": \"/infra/lb-client-ssl-profiles/default-high-compatibility-client-ssl-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1543304450931,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1543304450931,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0 },\n {\n \"cipher_group_label\": \"HIGH_SECURITY\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"session_cache_timeout\": 300,\n \"prefer_server_ciphers\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBClientSslProfile\",\n \"id\": \"default-high-security-client-ssl-profile\",\n \"display_name\": \"default-high-security-client-ssl-profile\",\n \"path\": \"/infra/lb-client-ssl-profiles/default-high-security-client-ssl-profile\",\n \"relative_path\": \"default-high-security-client-ssl-profile\",\n \"parent_path\": \"/infra/lb-client-ssl-profiles/default-high-security-client-ssl-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1543304450957,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1543304450957,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0 }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/napp/deployment/platform/versions": {
"get": {
"tags": [
"NSX Application Platform",
"Deployment",
"Platform",
"Versions"
],
"summary": "Get NSX Application Platform versions",
"description": "Get NSX Application Platform versions.",
"operationId": "GetAvailableVersions",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentVersions"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/napp/deployment/platform/versions\n",
"x-vmw-nsx-module": "PolicyCloudNativePlatform",
"x-vmw-nsx-example-response": "{\n \"versions\":[\n {\n \"version\": \"2.0\",\n \"chart_name\": \"platform\"\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/sub-clusters": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Nodes",
"Transport Node Collections"
],
"summary": "List sub-clusters",
"description": "Paginated list of all sub-clusters.\n",
"operationId": "ListSubClusters",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubClusterListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/sub-clusters\n",
"x-vmw-nsx-module": "SubCluster",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"compute_collection_id\": \"0d25110c-b483-4e6e-95e4-f7b904b297bf:domain-c9\",\n \"sub_cluster_info\": {\n \"sub_cluster_type\": \"MANUAL\",\n \"discovered_node_ids\": [\n \"57e6560e-acd3-4783-baa0-59143307524b:host-1043\",\n \"47e6560e-acd3-4783-baa0-59143307524b:host-1044\",\n \"37e6560e-acd3-4783-baa0-59143307524b:host-1045\"\n ]\n },\n \"resource_type\": \"SubCluster\",\n \"id\": \"cluster-1\",\n \"display_name\": \"cluster-1\",\n \"path\": \"/infra/sites/default/enforcement-points/default/sub-clusters/cluster-1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1607501697823,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1607582307987,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/context-profiles/{context-profile-id}": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Get PolicyContextProfile",
"description": "Get a single PolicyContextProfile by id\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPolicyContextProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "context-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/testPolicyContextProfile\n{\n \"resource_type\":\"PolicyContextProfile\",\n \"display_name\":\"testPolicyContextProfile\",\n \"description\":\"Test Policy Context Profile\",\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\":[\n \"TLS\"\n ],\n \"datatype\":\"STRING\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"ENCRYPTION_ALGORITHM\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\":\"STRING\"\n }\n ],\n },\n {\n \"key\":\"DOMAIN_NAME\",\n \"value\": [\n \"*.office365.com\"\n ],\n \"datatype\":\"STRING\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyContextProfile"
},
"put": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Create PolicyContextProfile",
"description": "Creates/Updates a PolicyContextProfile, which encapsulates attribute and\nsub-attributes of network services.\nRules for using attributes and sub-attributes in single PolicyContextProfile\n1. One type of attribute can't have multiple occurrences. ( Eg. -\n Attribute type APP_ID can be used only once per PolicyContextProfile.)\n2. For specifying multiple values for an attribute, provide them in an array.\n3. If sub-attribtes are mentioned for an attribute, then only single\n value is allowed for that attribute.\n4. To get a list of supported attributes and sub-attributes fire the following REST API\n GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes\n5. Do not create context profile with \"custom_attributes\" id\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPutCreateOrUpdatePolicyContextProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "context-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/context-profiles/testPolicyContextProfile\n{\n \"resource_type\":\"PolicyContextProfile\",\n \"display_name\":\"testPolicyContextProfile\",\n \"description\":\"Test Policy Context Profile\",\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\":[\n \"SSL\"\n ],\n \"datatype\":\"STRING\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\": [\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"TLS_CIPHER_SUITE\",\n \"value\": [\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\":\"STRING\"\n }\n ]\n },\n {\n \"key\":\"DOMAIN_NAME\",\n \"value\": [\n \"*.office365.com\"\n ],\n \"datatype\":\"STRING\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-codegen-request-body-name": "PolicyContextProfile"
},
"delete": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Delete Policy Context Profile",
"description": "Deletes the specified Policy Context Profile. If the Policy Context\nProfile is consumed in a firewall rule, it won't get deleted.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeletePolicyContextProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "context-profile-id",
"in": "path",
"description": "Policy Context Profile Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force delete the resource even if it is being used somewhere\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "override",
"in": "query",
"description": "Delete the locally overridden global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/context-profiles/testPolicyContextProfile\n",
"x-vmw-nsx-module": "PolicyContextProfile"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"Context Profiles"
],
"summary": "Create PolicyContextProfile",
"description": "Creates/Updates a PolicyContextProfile, which encapsulates attribute and\nsub-attributes of network services.\nRules for using attributes and sub-attributes in single PolicyContextProfile\n1. One type of attribute can't have multiple occurrences. ( Eg. -\n Attribute type APP_ID can be used only once per PolicyContextProfile.)\n2. For specifying multiple values for an attribute, provide them in an array.\n3. If sub-attribtes are mentioned for an attribute, then only single\n value is allowed for that attribute.\n4. To get a list of supported attributes and sub-attributes fire the following REST API\n GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes\n5. Do not create context profile with \"custom_attributes\" id\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchCreateOrUpdatePolicyContextProfile",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "context-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "override",
"in": "query",
"description": "Locally override the global object",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContextProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/context-profiles/testPolicyContextProfile\n{\n \"resource_type\":\"PolicyContextProfile\",\n \"display_name\":\"testPolicyContextProfile\",\n \"description\":\"Test Policy Context Profile\",\n \"attributes\":[\n {\n \"key\":\"APP_ID\",\n \"value\":[\n \"SSL\"\n ],\n \"datatype\":\"STRING\",\n \"sub_attributes\":[\n {\n \"key\":\"TLS_VERSION\",\n \"value\":[\n \"TLS_V13\"\n ],\n \"datatype\":\"STRING\"\n },\n {\n \"key\":\"TLS_CIPHER_SUITE\",\n \"value\":[\n \"TLS_RSA_EXPORT_WITH_RC4_40_MD5\"\n ],\n \"datatype\":\"STRING\"\n }\n ]\n },\n {\n \"key\":\"DOMAIN_NAME\",\n \"value\":[\n \"*.office365.com\"\n ],\n \"datatype\":\"STRING\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyContextProfile",
"x-codegen-request-body-name": "PolicyContextProfile"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"Port"
],
"summary": "Get VPC Subnet Port by ID",
"description": "Get detail information on VPC Subnet Port by giving ID.\n",
"operationId": "GetVpcSubnetPort",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnetPort"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ports/port-1\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"VpcSubnetPort\",\n \"id\": \"port1\",\n \"display_name\": \"port1\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ports/port-1\",\n \"relative_path\": \"port1\",\n \"parent_path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\",\n \"address_bindings\": [\n { \"ip_address\":\"1.1.1.1\", \"mac_address\":\"aa:bb:cc:dd:ee:ff\", \"vlan_id\": 0 },\n { \"ip_address\":\"1.1.1.2\", \"mac_address\":\"aa:bb:cc:dd:ee:f1\", \"vlan_id\": 0 }\n ],\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544503100539,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544503100539,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"Port"
],
"summary": "Create or update a VPC Subnet Port",
"description": "Create a VPC Subnet port if it does not exist based on the IDs, or update existing port\ninformation by replacing the port object already exists.\n",
"operationId": "UpdateVpcSubnetPort",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnetPort"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnetPort"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ports/port1\n {\n \"address_bindings\": [\n { \"ip_address\":\"1.1.1.1\", \"mac_address\":\"aa:bb:cc:dd:ee:ff\" },\n { \"ip_address\":\"1.1.1.2\", \"mac_address\":\"aa:bb:cc:dd:ee:f1\" }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"VpcSubnetPort\",\n \"id\": \"port1\",\n \"display_name\": \"port1\",\n \"path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ports/port-1\",\n \"relative_path\": \"port1\",\n \"parent_path\": \"/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1\",\n \"address_bindings\": [\n { \"ip_address\":\"1.1.1.1\", \"mac_address\":\"aa:bb:cc:dd:ee:ff\", \"vlan_id\": 0 },\n { \"ip_address\":\"1.1.1.2\", \"mac_address\":\"aa:bb:cc:dd:ee:f1\", \"vlan_id\": 0 }\n ],\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1544503100539,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1544503100539,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "VpcSubnetPort"
},
"delete": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"Port"
],
"summary": "Delete a VPC Subnet Port",
"description": "Delete a VPC Subnet Port by giving ID.\n",
"operationId": "DeleteVpcSubnetPort",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ports/port-1\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Connectivity",
"Subnet",
"Port"
],
"summary": "Patch a VPC Subnet Port",
"description": "Create a VPC Subnet port if it does not exist based on the IDs, or update existing port\ninformation by replacing the port object fields which presents in the request body.\n",
"operationId": "PatchVpcSubnetPort",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subnet-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VpcSubnetPort"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ports/port-1\n {\n \"address_bindings\": [\n { \"ip_address\":\"1.1.1.1\", \"mac_address\":\"aa:bb:cc:dd:ee:ff\" },\n { \"ip_address\":\"1.1.1.2\", \"mac_address\":\"aa:bb:cc:dd:ee:f1\" }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyVpcSubnet",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "VpcSubnetPort"
}
},
"/infra/lb-server-ssl-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Profiles",
"Load Balancer SSL Profiles",
"Load Balancer Server SSL Profiles"
],
"summary": "List LBServerSslProfiles",
"description": "Paginated list of all LBServerSslProfiles.\n\n
\n
NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.",
"operationId": "ListLBServerSslProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LBServerSslProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/lb-server-ssl-profiles\n",
"x-vmw-nsx-module": "PolicyLoadBalancer",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 3,\n \"results\": [\n {\n \"cipher_group_label\": \"BALANCED\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBServerSslProfile\",\n \"id\": \"default-balanced-server-ssl-profile\",\n \"display_name\": \"default-balanced-server-ssl-profile\",\n \"path\": \"/infra/lb-server-ssl-profiles/default-balanced-server-ssl-profile\",\n \"relative_path\": \"default-balanced-server-ssl-profile\",\n \"parent_path\": \"/infra/lb-server-ssl-profiles/default-balanced-server-ssl-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1543304450989,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1543304450989,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"cipher_group_label\": \"HIGH_COMPATIBILITY\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBServerSslProfile\",\n \"id\": \"default-high-compatibility-server-ssl-profile\",\n \"display_name\": \"default-high-compatibility-server-ssl-profile\",\n \"path\": \"/infra/lb-server-ssl-profiles/default-high-compatibility-server-ssl-profile\",\n \"relative_path\": \"default-high-compatibility-server-ssl-profile\",\n \"parent_path\": \"/infra/lb-server-ssl-profiles/default-high-compatibility-server-ssl-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1543304450974,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1543304450974,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"cipher_group_label\": \"HIGH_SECURITY\",\n \"ciphers\": [\n \"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\",\n \"TLS_RSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_RSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\"\n ],\n \"protocols\": [\n \"TLS_V1_2\"\n ],\n \"session_cache_enabled\": true,\n \"is_secure\": true,\n \"is_fips\": true,\n \"resource_type\": \"LBServerSslProfile\",\n \"id\": \"default-high-security-server-ssl-profile\",\n \"display_name\": \"default-high-security-server-ssl-profile\",\n \"path\": \"/infra/lb-server-ssl-profiles/default-high-security-server-ssl-profile\",\n \"relative_path\": \"default-high-security-server-ssl-profile\",\n \"parent_path\": \"/infra/lb-server-ssl-profiles/default-high-security-server-ssl-profile\",\n \"marked_for_delete\": false,\n \"_create_user\": \"system\",\n \"_create_time\": 1543304450998,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1543304450998,\n \"_system_owned\": true,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/lb-services/{lb-service-id}/lb-virtual-servers/{lb-virtual-server-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Load Balancing",
"Load Balancer Usage",
"Statistics"
],
"summary": "Get LBVirtualServer statistics information",
"description": "Get LBVirtualServerStatistics information.\n- no enforcement point path specified: Information will be aggregated from\neach enforcement point.\n- {enforcement_point_path}: Information will be retrieved only from the\ngiven enforcement point.\nThis API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.\n",
"operationId": "GetLBVirtualServerStatistics",
"parameters": [
{
"name": "lb-service-id",
"in": "path",
"description": "LBService id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "lb-virtual-server-id",
"in": "path",
"description": "LBVirtualServer id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateLBVirtualServerStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-module": "PolicyLBStatistics"
}
},
"/global-infra/services/{service-id}/service-entries": {
"get": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "List Service entries for the given service",
"description": "Paginated list of Service entries for the given service\n",
"operationId": "GlobalInfraListServiceEntries",
"parameters": [
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceEntryListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/services/my-http/service-entries\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"MyHttpEntry\",\n \"display_name\": \"MyHttpEntry\",\n \"path\": \"/infra/services/my-http/service-entries/MyHttpEntry\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"MyHttpEntry\",\n \"destination_ports\": [\n \"8080\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677617,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677617,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"https\",\n \"display_name\": \"MyHttps\",\n \"path\": \"/infra/services/my-http/service-entries/https\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"https\",\n \"destination_ports\": [\n \"7443\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517316057383,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517316057383,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/segments/{segment-id}/mac-table": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"MAC Table"
],
"summary": "Get infra segment MAC table",
"description": "Returns MAC table for a segment\n",
"operationId": "GlobalInfraGetInfraSegmentMacTable",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMacAddressListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://policy-mgr/policy/api/v1/infra/segments/TIER0_DOWN_LINK_SWITCH/mac-table?source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"last_update_timestamp\": 1591767144064,\n \"results\": [\n {\n \"mac_address\": \"00:0c:29:ce:0f:77\",\n \"tep_ip\": \"100.100.100.3\",\n \"tep_mac_address\": \"00:50:56:6a:af:ce\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Segment Security Profile Binding"
],
"summary": "List segment security profile binding maps",
"description": "API will list all segment security profile binding maps.\n",
"operationId": "GlobalInfraListSegmentSecurityProfileBindings",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"description": "tier-1 gateway id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "segment id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentSecurityProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/\n",
"x-vmw-nsx-module": "PolicySecurityProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentSecurityProfileBindingMap\",\n \"id\": \"segment_security_binding_map_1\",\n \"display_name\": \"segment_security_binding_map_1\",\n \"path\": \"/infra/tier-1s/tier1_1/segments/segment_1/segment-security-profile-binding-maps/segment_security_binding_map_1\",\n \"parent_path\": \"/infra/tier-1s/tier1_1/segments/segment_1\",\n \"relative_path\": \"segment_security_binding_map_1\",\n \"marked_for_delete\": false,\n \"spoofguard_profile_path\": \"/infra/spoofguard-profiles/spoofguardprofile_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1539129320511,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1539129593401,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/security-policies/{security-policy-id}/container-cluster-span": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Container Cluster"
],
"summary": "List all container cluster span of a security policy",
"description": "List all container cluster span of a security policy\n",
"operationId": "ListContainerClustersForSecurityPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicyContainerClusterListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/security-policies/application-1/container-cluster-span\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"SecurityPolicyContainerCluster\",\n \"description\": \"antrea cluster 1\",\n \"display_name\": \"AntreaCluster 1\",\n \"container_cluster_type\": \"ANTREA\",\n \"container_cluster_path\":\"/infra/sites/default/enforcement-points/default/antrea-nodes/antrea-cluster-1\"\n \"id\": \"antrea-cluster-1\",\n \"path\": \"//infra/domains/vmc/security-policies/application-section-1/container-cluster-span/antrea-cluster-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"antrea-cluster-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"SecurityPolicyContainerCluster\",\n \"description\": \"antrea cluster 2\",\n \"display_name\": \"AntreaCluster 2\",\n \"container_cluster_type\": \"ANTREA\",\n \"container_cluster_path\":\"/infra/sites/default/enforcement-points/default/antrea-nodes/antrea-cluster-2\"\n \"id\": \"antrea-cluster-1\",\n \"path\": \"//infra/domains/vmc/security-policies/application-section-1/container-cluster-span/antrea-cluster-2\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"antrea-cluster-2\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/domains/{domain-id}/groups/{group-id}/members/dvpg": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Discovered Port Groups that belong to this Group",
"description": "Get Discovered Port Groups that belong to this Group\n",
"operationId": "GlobalInfraGetGroupDVPGMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/dvpg?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"id\": \"dvpg-1\",\n \"display_name\": \"segment-1\",\n \"path\": \"/infra/segments/segment-1\"\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Multicast"
],
"summary": "Read Multicast Configuration",
"description": "Read Multicast Configuration.\n",
"operationId": "ReadPolicyTier1MulticastConfig",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTier1MulticastConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET /infra/tier-1s/tier1/locale-services/tier1localeservices/multicast\n",
"x-vmw-nsx-module": "PolicyMulticast",
"x-vmw-nsx-example-response": "{\n \"enabled\": true,\n \"resource_type\": \"PolicyMulticastConfig\",\n \"id\": \"multicast\",\n \"display_name\": \"multicast\",\n \"path\": \"/infra/tier-1s/test/locale-services/default/multicast/\",\n \"relative_path\": \"multicast\",\n \"parent_path\": \"/infra/tier-1s/test\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1556143021967,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1556227807243,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Multicast"
],
"summary": "Create or update multicast configuration",
"description": "Create or update a Tier-1 multicast configuration defining the multicast replication range.\nIt will update the configuration if there is already one in place.\n",
"operationId": "CreateOrUpdatePolicyTier1MulticastConfig",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTier1MulticastConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTier1MulticastConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT /infra/tier-1s/tier1/locale-services/tier1localeservices/multicast\n{\n \"enabled\" : true,\n }\n",
"x-vmw-nsx-module": "PolicyMulticast",
"x-vmw-nsx-example-response": "{\n \"enabled\": true,\n \"resource_type\": \"PolicyTier1MulticastConfig\",\n \"id\": \"multicast\",\n \"display_name\": \"multicast\",\n \"path\": \"/infra/tier-1s/test/locale-services/default/multicast/\",\n \"relative_path\": \"multicast\",\n \"parent_path\": \"/infra/tier-1s/test\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1556143021967,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1556227807243,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n}\n",
"x-codegen-request-body-name": "PolicyTier1MulticastConfig"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Multicast"
],
"summary": "Create or update multicast configuration",
"description": "Create or update a Tier-1 multicast configuration defining the multicast replication range.\nIt will update the configuration if there is already one in place.\n",
"operationId": "PatchPolicyTier1MulticastConfig",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-services-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyTier1MulticastConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH /infra/tier-1s/tier1/locale-services/tier1localeservices/multicast\n {\n \"enabled\" : true,\n }\n",
"x-vmw-nsx-module": "PolicyMulticast",
"x-codegen-request-body-name": "PolicyTier1MulticastConfig"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"ARP Table"
],
"summary": "Get ARP table from segment interface (downlink) in CSV format",
"description": "Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the\ninterface (downlink) attaching segment to tier1 gateway, on a edge\nnode specified in edge_path parameter.\nThe edge_path parameter is mandatory.\n",
"operationId": "GlobalInfraGetSegmentInterfaceArpTableCsv",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "host_transport_node_path",
"in": "query",
"description": "Policy path of host transport node",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/InterfaceArpTableInCsvFormat"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/segments/web-app-seg/arp-table?format=csv&enforcement_point_path=/infra/sites/default/enforcement-points/default&edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "mac_address,ip\n02:50:56:56:44:52,172.16.20.1\n"
}
},
"/infra/host-switch-profiles/{host-switch-profile-id}": {
"get": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Profiles",
"Hostswitch Profiles"
],
"summary": "Get a Hostswitch Profile by ID",
"description": "Returns information about a specified hostswitch profile.",
"operationId": "GetPolicyHostSwitchProfile",
"parameters": [
{
"name": "host-switch-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyBaseHostSwitchProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/host-switch-profiles/uplinkProfile1\n",
"x-vmw-nsx-module": "PolicyBaseHostSwitchProfile",
"x-vmw-nsx-example-response": "{\n \"lags\": [\n {\n \"name\": \"lag1\",\n \"id\": \"45412\",\n \"mode\": \"ACTIVE\",\n \"load_balance_algorithm\": \"SRCMAC\",\n \"number_of_uplinks\": 2,\n \"uplinks\": [\n {\n \"uplink_name\": \"lag1-0\",\n \"uplink_type\": \"PNIC\"\n },\n {\n \"uplink_name\": \"lag1-1\",\n \"uplink_type\": \"PNIC\"\n }\n ],\n \"timeout_type\": \"FAST\"\n }\n ],\n \"teaming\": {\n \"policy\": \"LOADBALANCE_SRC_MAC\",\n \"active_list\": [\n {\n \"uplink_name\": \"lag1\",\n \"uplink_type\": \"LAG\"\n }\n ]\n },\n \"transport_vlan\": 19,\n \"overlay_encap\": \"GENEVE\",\n \"resource_type\": \"PolicyUplinkHostSwitchProfile\",\n \"id\": \"uplinkProfile1\",\n \"display_name\": \"CustomLagProfile-LOADBALANCE_SRC_MAC\",\n \"path\": \"/infra/host-switch-profiles/uplinkProfile1\",\n \"relative_path\": \"uplinkProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"7917d0ba-4388-4f3f-921f-94d09959007a\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 1612407975428,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612407975428,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Profiles",
"Hostswitch Profiles"
],
"summary": "Create or update a Hostswitch Profile",
"description": "Create or update a hostswitch profile. The resource_type is required and needs to be\none of the following,\nUplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile &\nExtraConfigHostSwitchProfile.\nUplink profile - For uplink profiles, the teaming and policy parameters are\nrequired. By default, the mtu is 1600 and the transport_vlan is 0. The\nsupported MTU range is 1280 through (uplink_mtu_threshold).\nuplink_mtu_threshold is 9000 by default. Range can be extended by modifying\n(uplink_mtu_threshold) in SwitchingGlobalConfig to the required upper threshold.\nTeaming defined in this profile allows NSX to load balance traffic across\ndifferent physical NICs (PNICs) on the hypervisor hosts. Multiple teaming\npolicies are supported, including LACP active, LACP passive, load balancing\nbased on source ID, and failover order.\nLldp profile - Activate or deactivate sending LLDP packets\nNiocProfile - Network I/O Control settings: defines limits, shares and\nreservations for various host traffic types.\nExtraConfig - Vendor specific configuration on HostSwitch, logical switch\nor logical port\n",
"operationId": "CreateOrUpdatePolicyHostSwitchProfile",
"parameters": [
{
"name": "host-switch-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyBaseHostSwitchProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyBaseHostSwitchProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/host-switch-profiles/uplinkProfile1\n{\n \"id\" : \"uplinkProfile1\",\n \"lags\": [\n {\n \"name\": \"lag1\",\n \"id\": \"28158\",\n \"mode\": \"ACTIVE\",\n \"load_balance_algorithm\": \"SRCMAC\",\n \"number_of_uplinks\": 2,\n \"uplinks\": [\n {\n \"uplink_name\": \"lag1-0\",\n \"uplink_type\": \"PNIC\"\n },\n {\n \"uplink_name\": \"lag1-1\",\n \"uplink_type\": \"PNIC\"\n }\n ],\n \"timeout_type\": \"FAST\"\n }\n ],\n \"teaming\": {\n \"policy\": \"LOADBALANCE_SRC_MAC\",\n \"active_list\": [\n {\n \"uplink_name\": \"lag1\",\n \"uplink_type\": \"LAG\"\n }\n ]\n },\n \"transport_vlan\": 19,\n \"overlay_encap\": \"GENEVE\",\n \"resource_type\": \"PolicyUplinkHostSwitchProfile\",\n \"display_name\": \"CustomLagProfile-LOADBALANCE_SRC_MAC\"\n}\n",
"x-vmw-nsx-module": "PolicyBaseHostSwitchProfile",
"x-vmw-nsx-example-response": "{\n \"lags\": [\n {\n \"name\": \"lag1\",\n \"id\": \"45412\",\n \"mode\": \"ACTIVE\",\n \"load_balance_algorithm\": \"SRCMAC\",\n \"number_of_uplinks\": 2,\n \"uplinks\": [\n {\n \"uplink_name\": \"lag1-0\",\n \"uplink_type\": \"PNIC\"\n },\n {\n \"uplink_name\": \"lag1-1\",\n \"uplink_type\": \"PNIC\"\n }\n ],\n \"timeout_type\": \"FAST\"\n }\n ],\n \"teaming\": {\n \"policy\": \"LOADBALANCE_SRC_MAC\",\n \"active_list\": [\n {\n \"uplink_name\": \"lag1\",\n \"uplink_type\": \"LAG\"\n }\n ]\n },\n \"transport_vlan\": 19,\n \"overlay_encap\": \"GENEVE\",\n \"resource_type\": \"PolicyUplinkHostSwitchProfile\",\n \"id\": \"uplinkProfile1\",\n \"display_name\": \"CustomLagProfile-LOADBALANCE_SRC_MAC\",\n \"path\": \"/infra/host-switch-profiles/uplinkProfile1\",\n \"relative_path\": \"uplinkProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"7917d0ba-4388-4f3f-921f-94d09959007a\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 1612407975428,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612407975428,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyBaseHostSwitchProfile"
},
"delete": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Profiles",
"Hostswitch Profiles"
],
"summary": "Delete a Hostswitch Profile",
"description": "Deletes a specified hostswitch profile.",
"operationId": "DeletePolicyHostSwitchProfile",
"parameters": [
{
"name": "host-switch-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/host-switch-profiles/hsProfile1\n",
"x-vmw-nsx-module": "PolicyBaseHostSwitchProfile",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"System Administration",
"Configuration",
"Fabric",
"Profiles",
"Hostswitch Profiles"
],
"summary": "Create or update a Hostswitch Profile",
"description": "Patch a hostswitch profile. The resource_type is required and needs to be\none of the following,\nUplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile &\nExtraConfigHostSwitchProfile.\nUplink profile - For uplink profiles, the teaming and policy parameters are\nrequired. By default, the mtu is 1600 and the transport_vlan is 0. The\nsupported MTU range is 1280 through (uplink_mtu_threshold).\nuplink_mtu_threshold is 9000 by default. Range can be extended by modifying\n(uplink_mtu_threshold) in SwitchingGlobalConfig to the required upper threshold.\nTeaming defined in this profile allows NSX to load balance traffic across\ndifferent physical NICs (PNICs) on the hypervisor hosts. Multiple teaming\npolicies are supported, including LACP active, LACP passive, load balancing\nbased on source ID, and failover order.\nLldp profile - Activate or deactivate sending LLDP packets\nNiocProfile - Network I/O Control settings: defines limits, shares and\nreservations for various host traffic types.\nExtraConfig - Vendor specific configuration on HostSwitch, logical switch\nor logical port\n",
"operationId": "PatchPolicyHostSwitchProfile",
"parameters": [
{
"name": "host-switch-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyBaseHostSwitchProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyBaseHostSwitchProfile"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/host-switch-profiles/uplinkProfile1\n{\n \"lags\": [\n {\n \"name\": \"lag2\",\n \"id\": \"49114\",\n \"mode\": \"ACTIVE\",\n \"load_balance_algorithm\": \"SRCMAC\",\n \"number_of_uplinks\": 2,\n \"uplinks\": [\n {\n \"uplink_name\": \"lag2-0\",\n \"uplink_type\": \"PNIC\"\n },\n {\n \"uplink_name\": \"lag2-1\",\n \"uplink_type\": \"PNIC\"\n }\n ],\n \"timeout_type\": \"FAST\"\n }\n ],\n \"teaming\": {\n \"policy\": \"LOADBALANCE_SRC_MAC\",\n \"active_list\": [\n {\n \"uplink_name\": \"lag2\",\n \"uplink_type\": \"LAG\"\n }\n ]\n },\n \"transport_vlan\": 19,\n \"overlay_encap\": \"GENEVE\",\n \"resource_type\": \"PolicyUplinkHostSwitchProfile\",\n \"id\": \"uplinkProfile1\",\n \"display_name\": \"CustomLagProfile-LOADBALANCE_SRC_MAC\",\n \"path\": \"/infra/host-switch-profiles/uplinkProfile1\",\n \"relative_path\": \"uplinkProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"7917d0ba-4388-4f3f-921f-94d09959007a\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 0,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612408913822,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyBaseHostSwitchProfile",
"x-vmw-nsx-example-response": "{\n \"lags\": [\n {\n \"name\": \"lag2\",\n \"id\": \"45412\",\n \"mode\": \"ACTIVE\",\n \"load_balance_algorithm\": \"SRCMAC\",\n \"number_of_uplinks\": 2,\n \"uplinks\": [\n {\n \"uplink_name\": \"lag2-0\",\n \"uplink_type\": \"PNIC\"\n },\n {\n \"uplink_name\": \"lag2-1\",\n \"uplink_type\": \"PNIC\"\n }\n ],\n \"timeout_type\": \"FAST\"\n }\n ],\n \"teaming\": {\n \"policy\": \"LOADBALANCE_SRC_MAC\",\n \"active_list\": [\n {\n \"uplink_name\": \"lag2\",\n \"uplink_type\": \"LAG\"\n }\n ]\n },\n \"transport_vlan\": 19,\n \"overlay_encap\": \"GENEVE\",\n \"resource_type\": \"PolicyUplinkHostSwitchProfile\",\n \"id\": \"uplinkProfile1\",\n \"display_name\": \"CustomLagProfile-LOADBALANCE_SRC_MAC\",\n \"path\": \"/infra/host-switch-profiles/uplinkProfile1\",\n \"relative_path\": \"uplinkProfile1\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"7917d0ba-4388-4f3f-921f-94d09959007a\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"unknown\",\n \"_create_time\": 1612407975428,\n \"_last_modified_user\": \"unknown\",\n \"_last_modified_time\": 1612407975428,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "PolicyBaseHostSwitchProfile"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-context": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Read an L2Vpn Context",
"description": "Read L2Vpn Context.\nThis API is deprecated. Please use GET /infra/tier-0s//locale-services/\n/l2vpn-services/default instead.\n",
"operationId": "ReadL2VpnContext",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VpnContext"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/default/l2vpn-context\n",
"x-vmw-nsx-module": "PolicyL2Vpn",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"L2VpnContext\",\n \"id\": \"l2vpn-context\",\n \"display_name\": \"/infra/tier-0s/vmc/locale-services/default/l2vpn-services/default\",\n \"path\": \"/infra/tier-0s/vmc/locale-services/default/l2vpn-services/default\",\n \"parent_path\": \"/infra/tier-0s/vmc/locale-services/default\",\n \"relative_path\": \"l2vpn-context\",\n \"enable_hub\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1515535295254,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1515535295254,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/features": {
"get": {
"tags": [
"Policy",
"Feature Flag",
"Aggregated Feature State"
],
"summary": "Read Aggregated Feature State",
"description": "Paginated list of all Aggregated Feature State",
"operationId": "ListAggregatedFeatureState",
"parameters": [
{
"name": "site_path",
"in": "query",
"description": "null",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatedFeatureListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/features?site_path=/infra/site/default\n",
"x-vmw-nsx-module": "PolicyFeatureFlags"
}
},
"/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code": {
"post": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Sessions"
],
"summary": "Create or patch an L2VPN session under Tier-1 from Peer Codes",
"description": "Create or patch an L2VPN session under Tier-1 from Peer Codes.\nIn addition to the L2VPN Session, the IPSec VPN Session, along\nwith the IKE, Tunnel, and DPD Profiles are created and owned by\nthe system. IPSec VPN Service and Local Endpoint are created only\nwhen required, i.e., an IPSec VPN Service does not already exist,\nor an IPSec VPN Local Endpoint with same local address does not\nalready exist.\nUpdating the L2VPN Session can be performed only through this API\nby specifying new peer codes. Use of specific APIs to update the\nL2VPN Session and the different resources associated with it is\nnot allowed, except for IPSec VPN Service and Local Endpoint,\nresources that are not system owned.\nAPI supported only when L2VPN Service is in Client Mode.\n",
"operationId": "CreateOrPatchTier1VpnL2VPNSessionFromPeerCodes",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNSessionData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default/sessions/stretched-pa-site?action=create_with_peer_codes\n{\n \"description\": \"Stretched Palo Alto Site\",\n \"display_name\": \"stretched-pa-site\",\n \"transport_tunnels\": [\n {\n \"peer_code\": \"MCw0YTc2YTNlLHsic2l0ZU5hbWUiOiJwb2xpY3ktc2Vzc2lvbi1QUk9WSURFUi5obWl6YS5wYS1wdW5lLXJiLXZwbiIs\n InNyY1RhcElwIjoiMTY5LjI1NC42NC4yIiwiZHN0VGFwSXAiOiIxNjkuMjU0LjY0LjEiLCJpa2VPcHRpb24iOiJpa2V2\n MiIsImVuY2FwUHJvdG8iOiJncmUvaXBzZWMiLCJkaEdyb3VwIjoiZGgxNCIsImVuY3J5cHRBbmREaWdlc3QiOiJhZXMt\n Z2NtL3NoYS0yNTYiLCJwc2siOiJkZWZhdWx0IiwidHVubmVscyI6W3sibG9jYWxJZCI6IjI0LjI0LjI0LjI0IiwicGVl\n cklkIjoiMTEuMTEuMTEuMTEifV19\",\n \"peer_address\": \"10.10.10.10\",\n \"local_address\": \"20.20.20.20\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-codegen-request-body-name": "L2VPNSessionData"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Statistics"
],
"summary": "Get segment statistics information",
"description": "Get tier1 segment statistics information.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetSegmentStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/it_t1/segments/it-t1-seg/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"rx_packets\": {\n \"multicast_broadcast\": 19914,\n \"dropped\": 2358,\n \"total\": 28909\n },\n \"rx_bytes\": {\n \"multicast_broadcast\": 1692690,\n \"dropped\": 0,\n \"total\": 3692670\n },\n \"tx_packets\": {\n \"multicast_broadcast\": 19914,\n \"dropped\": 0,\n \"total\": 28968\n },\n \"tx_bytes\": {\n \"multicast_broadcast\": 1493550,\n \"dropped\": 0,\n \"total\": 2853978\n },\n \"dropped_by_security_packets\": {\n \"spoof_guard_dropped\": [\n {\n \"packet_type\": \"IPV4\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"IPV6\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"ARP\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"ND\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"NON_IP\",\n \"counter\": 0\n }\n ],\n \"bpdu_filter_dropped\": 0,\n \"dhcp_server_dropped_ipv4\": 0,\n \"dhcp_server_dropped_ipv6\": 0,\n \"dhcp_client_dropped_ipv4\": 0,\n \"dhcp_client_dropped_ipv6\": 0\n },\n \"mac_learning\": {\n \"mac_not_learned_packets_allowed\": 0,\n \"mac_not_learned_packets_dropped\": 0,\n \"macs_learned\": 0\n },\n \"logical_switch_id\": \"3df039b1-d031-4733-987f-fcf8a4ed3e5b\",\n \"last_update_timestamp\": 1548964636611\n}\n"
}
},
"/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Statistics"
],
"summary": "Get segment statistics information",
"description": "Get tier1 segment statistics information.\n",
"operationId": "GlobalInfraGetSegmentStatistics",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentStatistics"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/it_t1/segments/it-t1-seg/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"rx_packets\": {\n \"multicast_broadcast\": 19914,\n \"dropped\": 2358,\n \"total\": 28909\n },\n \"rx_bytes\": {\n \"multicast_broadcast\": 1692690,\n \"dropped\": 0,\n \"total\": 3692670\n },\n \"tx_packets\": {\n \"multicast_broadcast\": 19914,\n \"dropped\": 0,\n \"total\": 28968\n },\n \"tx_bytes\": {\n \"multicast_broadcast\": 1493550,\n \"dropped\": 0,\n \"total\": 2853978\n },\n \"dropped_by_security_packets\": {\n \"spoof_guard_dropped\": [\n {\n \"packet_type\": \"IPV4\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"IPV6\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"ARP\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"ND\",\n \"counter\": 0\n },\n {\n \"packet_type\": \"NON_IP\",\n \"counter\": 0\n }\n ],\n \"bpdu_filter_dropped\": 0,\n \"dhcp_server_dropped_ipv4\": 0,\n \"dhcp_server_dropped_ipv6\": 0,\n \"dhcp_client_dropped_ipv4\": 0,\n \"dhcp_client_dropped_ipv6\": 0\n },\n \"mac_learning\": {\n \"mac_not_learned_packets_allowed\": 0,\n \"mac_not_learned_packets_dropped\": 0,\n \"macs_learned\": 0\n },\n \"logical_switch_id\": \"3df039b1-d031-4733-987f-fcf8a4ed3e5b\",\n \"last_update_timestamp\": 1548964636611\n}\n"
}
},
"/global-infra/settings/firewall/security/exclude-list?action=filter": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Exclusion List"
],
"summary": "Filter the firewall exclude list",
"description": "Filter the firewall exclude list by the given object, to check whether\nthe object is a member of this exclude list.\n",
"operationId": "GlobalInfraFilterFirewallExcludeList",
"parameters": [
{
"name": "deep_check",
"in": "query",
"description": "Check all parents",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "intent_path",
"in": "query",
"description": "Path of the intent object to be searched in the exclude list",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReference"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/exclude-list?action=filter&intent_path=/infra/domains/default/groups/app-group\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"target_display_name\": \"app-group\",\n \"is_valid\": true,\n \"target_type\": \"Group\",\n \"target_id\": \"app-group\",\n \"path\": \"/infra/domains/default/groups/app-group\"\n}\n"
}
},
"/infra/realized-state/unassociated-virtual-machines": {
"get": {
"tags": [
"Policy",
"Inventory",
"Virtual Machines"
],
"summary": "List all virtual machines which are not part of any group",
"description": "This API filters objects of type virtual machine which are not part of any group. This API also gives some VM\ndetails such as VM name, IDs and the current state of the VMs.\n",
"operationId": "ListAllUnAssociatedVirtualMachines",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/realized-state/unassociated-virtual-machines?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyRealizedState",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"compute_ids\": [\n \"moIdOnHost:1\",\n \"hostLocalId:1\",\n \"locationId:564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"instanceUuid:04fb2e78-e4bc-416f-b9dc-18b9f05e6227\",\n \"externalId:564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"biosUuid:564d75b2-7e28-7e78-dd77-64e5fd6128e1\"\n ],\n \"resource_type\": \"VirtualMachine\",\n \"external_id\": \"564d75b2-7e28-7e78-dd77-64e5fd6128e1\",\n \"source\": {\n \"target_display_name\": \"sc-rdops-vm09-dhcp-16-203.eng.vmware.com\",\n \"is_valid\": true,\n \"target_type\": \"HostNode\",\n \"target_id\": \"1afea8da-d4e2-11e7-93c3-c57b39f75a4f\"\n },\n \"_last_sync_time\": 1512031301409,\n \"display_name\": \"1-vm_ubuntu_1404_srv_64-local-586-04fb2e78-e4bc-416f-b9dc-18b9f05e6227\",\n \"type\": \"REGULAR\",\n \"power_state\": \"VM_RUNNING\",\n \"host_id\": \"1afea8da-d4e2-11e7-93c3-c57b39f75a4f\",\n \"local_id_on_host\": \"1\"\n }\n ]\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/route-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Routing",
"Route Maps"
],
"summary": "List route maps",
"description": "Paginated list of all route maps under a tier-0\n",
"operationId": "GlobalInfraListAllRouteMaps",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier0RouteMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/route-maps\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"RoueMap\",\n \"id\": \"rm1\",\n \"display_name\": \"rm1\",\n \"path\": \"/infra/tier-0s/vmc_prv/route-maps/rm1\",\n \"parent_path\": \"/infra/tier-0s/vmc_prv\",\n \"relative_path\": \"rm1\",\n \"entries\": [\n {\n \"community_list_matches\": [\n {\n \"criteria\": \"/infra/tier-0s/vmc/community-lists/cl1\",\n \"match_operator\": \"MATCH_ALL\"\n }],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n },\n {\n \"prefix_list_matches\": [ \"/infra/tier-0s/vmc/prefix-lists/pl1\" ],\n \"set\": {\n \"as_path_prepend\": \"3354 1234\",\n \"med\": 20,\n \"weight\": 12\n },\n \"action\": \"PERMIT\"\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516667421694,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516667421694,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/dns-security-profiles": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"DNS Security Profiles"
],
"summary": "List all DNS security profiles",
"description": "List all DNS security profiles",
"operationId": "GlobalInfraListDnsSecurityProfiles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DnsSecurityProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dns-security-profiles\n",
"x-vmw-nsx-module": "PolicyProfile",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"resource_type\" : \"DnsSecurityProfile\",\n \"id\" : \"default\",\n \"display_name\" : \"default-dns-profile\",\n \"path\" : \"/infra/dns-security-profiles/default\",\n \"parent_path\" : \"/infra/dns-security-profiles\",\n \"relative_path\" : \"default\",\n \"display_name\" : \"default-dns-profile\",\n \"ttl\" : 10000,\n \"_create_user\" : \"admin\",\n \"_create_time\" : 1517403652195,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517403652195,\n \"_system_owned\" : false,\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 1\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/ports/{port-id}/status": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Ports",
"Status"
],
"summary": "Get infra segment port status information",
"description": "Get infra segment port status information.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetInfraSegmentPortStatus",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segments-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bgp_neighbor_type",
"in": "query",
"description": "Bgp neighbor type",
"schema": {
"type": "string",
"enum": [
"INTER_SR",
"USER"
]
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "edge_path",
"in": "query",
"description": "Policy path of edge node",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "stats_type",
"in": "query",
"description": "Segment statistics type",
"schema": {
"type": "string",
"enum": [
"DATAPATH_STATS"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "Transport Node Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentPortStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/tier0-ls-2/ports/ls2-p1/status?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"logical_port_id\": \"04efc498-b872-40fc-83f8-ebf9317a2766\",\n \"last_update_timestamp\": 1453764613211,\n \"status\": \"UP\"\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segments (Fixed)"
],
"summary": "List all effective profiles for segment",
"description": "List all effective profiles for this segment on given enforcement point.",
"operationId": "ListSegmentEffectiveProfiles",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EffectiveProfilesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/pepsi/segments/tier1-ls/effective-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics"
}
},
"/infra/ip-pools/{ip-pool-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Read an IpAddressPool",
"description": "Read IpAddressPool with given Id.\n",
"operationId": "ReadIpAddressPool",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPool"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IpAddressPool\",\n \"id\": \"IpPool-Tenant-1\",\n \"display_name\": \"IpPool-Tenant-1\",\n \"path\": \"/infra/ip-pools/IpPool-Tenant-1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"IpPool-Tenant-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Create or Replace IpAddressPool",
"description": "Create a new IpAddressPool with given ID if it does not exist.\nIf IpAddressPool with given ID already exists, it will update existing instance.\nThis is a full replace.\n",
"operationId": "CreateOrReplaceIpAddressPool",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPool"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPool"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1\n{\n \"display_name\": \"IPBlock-Tenant-1\",\n \"description\": \"IPBlock-Tenant-1 Description\",\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"IpAddressPool\",\n \"id\": \"IpPool-Tenant-1\",\n \"display_name\": \"IpPool-Tenant-1\",\n \"path\": \"/infra/ip-pools/IpPool-Tenant-1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"IpPool-Tenant-1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516387911610,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516387911610,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "IpAddressPool"
},
"delete": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Delete an IpAddressPool",
"description": "Delete the IpAddressPool with the given id.\n",
"operationId": "DeleteIpAddressPool",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/IpPool-Tenant-1\n",
"x-vmw-nsx-module": "PolicyIpam"
},
"patch": {
"tags": [
"Policy",
"Networking",
"IP Management",
"IP Address Pools",
"IP Pools"
],
"summary": "Create a new IP address pool",
"description": "Creates a new IpAddressPool with specified ID if not already present.\nIf IpAddressPool of given ID is already present, then the instance is\nupdated. This is a full replace.\n",
"operationId": "CreateOrPatchIpAddressPool",
"parameters": [
{
"name": "ip-pool-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IpAddressPool"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1\n{\n \"display_name\": \"IpPool-Tenant-1\",\n \"description\": \"IpPool-Tenant-1 Description\"\n}\n",
"x-vmw-nsx-module": "PolicyIpam",
"x-codegen-request-body-name": "IpAddressPool"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Security",
"E-W Firewall"
],
"summary": "List E-W Firewall Rules",
"description": "List Rules\nGET /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules\n",
"operationId": "ListVpcPolicyRules",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules\n",
"x-vmw-nsx-module": "PolicyVpcPolicy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [{\n \"resource_type\": \"Rule\",\n \"description\": \"VPC Policy Rule1\",\n \"id\": \"rule-1\",\n \"display_name\": \"rule-1\",\n \"path\": \"/orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1\",\n \"parent_path\": \"/orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default\",\n \"relative_path\": \"rule-1\",\n \"sequence_number\": 1,\n \"source\": [\n \"/orgs/org1/projects/project1/vpcs/vpc-1/groups/group1\"\n ],\n \"destination\": [\n \"/orgs/org1/projects/project1/vpcs/vpc-1/groups/group2\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"logged\": true,\n \"disabled\": false,\n \"notes\": \"This is sample Policy Rule to allow HTTPS traffic between default and prod-policy\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Statistics"
],
"summary": "Get gateway rule statistics",
"description": "Get statistics of a gateway rule.\n- no enforcement point path specified: Stats will be evaluated on each enforcement.\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGatewayRuleStatistics",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/gateway-policies/emergency/rules/ce-1/statistics?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n {\n \"rule\": \"ce-1\",\n \"internal_rule_id\": \"1001\",\n \"packet_count\": 3806,\n \"session_count\": 819,\n \"hit_count\": 45,\n \"byte_count\": 322989,\n \"popularity_index\": 85,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n }\n ],\n \"cursor\" : 1,\n \"result_count\" : 1\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags": {
"get": {
"tags": [
"Policy",
"Multi Tenancy",
"NSX VPC",
"Tags"
],
"summary": "List all unique tags.",
"description": "Returns paginated list of all unique tags. Supports filtering by scope, tag and\nsource from which tags are synced. Supports starts with, ends with, equals and\ncontains operators on scope and tag values.\nTo filter tags by starts with on scope or tag, use '*' as suffix after the value.\nTo filter tags by ends with on scope or tag, use '*' as prefix before the value.\nTo filter tags by contain on scope or tag, use '*' as prefix and suffix on the value.\nBelow special characters in the filter value needs to be escaped with hex values.\n- Character '&' needs to be escaped as '%26'\n- Character '[' needs to be escaped as '%5B'\n- Character ']' needs to be escaped as '%5D'\n- Character '+' needs to be escaped as '%2B'\n- Character '#' needs to be escaped as '%23'\nSort option for list of unique tags is available only on tag and scope properties.\n",
"operationId": "ListAllVpcTags",
"parameters": [
{
"name": "org-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpc-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "scope",
"in": "query",
"description": "Tag scope",
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Source from which tags are synced.",
"schema": {
"type": "string",
"enum": [
"Amazon",
"Azure",
"NSX",
"ANY"
]
}
},
{
"name": "tag",
"in": "query",
"description": "Tag value",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagInfoListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/tags\n",
"x-vmw-nsx-module": "PolicyVpcTag",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"scope\": \"os\",\n \"tag\": \"windows\",\n \"tagged_objects\": 250\n },\n {\n \"scope\": \"os\",\n \"tag\": \"ubantu\",\n \"tagged_objects\": 100\n }\n ],\n \"result_count\": 2\n}\n{\n \"results\": [\n {\n \"scope\": \"os\",\n \"tag\": \"windows\",\n \"tagged_objects\": 250\n }\n ],\n \"result_count\": 1\n}\n{\n \"results\": [\n {\n \"scope\": \"os\",\n \"tag\": \"ubantu\",\n \"tagged_objects\": 100\n }\n ],\n \"result_count\": 1\n}\n"
}
},
"/infra/tls-inspection-policies": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Tls Inspection",
"Tls Rules"
],
"summary": "List TLS policies",
"description": "List all TLS policies.",
"operationId": "ListTlsPolicies",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_rule_count",
"in": "query",
"description": "Include the count of rules in policy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TlsPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tls-inspection-policies\n",
"x-vmw-nsx-module": "PolicyTlsPolicy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"TlsPolicy\",\n \"id\": \"default\",\n \"display_name\": \"default\",\n \"path\": \"/infra/tls-inspection-policies/default\"\n \"parent_path\": \"/infra\",\n \"relative_path\": \"default\",\n \"category\": \"SharedPreRules\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 50000,\n \"category\": \"LocalGatewayRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061800,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 6\n },\n {\n \"resource_type\": \"TlsPolicy\",\n \"id\": \"internal\",\n \"display_name\": \"internal\",\n \"path\": \"/infra/tls-inspection-policies/internal\"\n \"parent_path\": \"/infra\",\n \"relative_path\": \"internal\",\n \"category\": \"SharedPreRules\",\n \"sequence_number\": 100,\n \"internal_sequence_number\": 20100,\n \"category\": \"SharedPreRules\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469778,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516295469778,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Get IDS rule.",
"description": "Read intrusion detection rule\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetIdsRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"description": "Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp12/rules/Test-Rule14\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"action\": \"DETECT\",\n \"ids_profiles\": [\n \"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\"\n ],\n \"resource_type\": \"IdsRule\",\n \"id\": \"Test-Rule14\",\n \"display_name\": \"Test-Rule12\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp12/rules/Test-Rule14\",\n \"relative_path\": \"Test-Rule14\",\n \"parent_path\": \"/infra/domains/default/intrusion-service-policies/sp12\",\n \"unique_id\": \"3054\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"rule_id\": 3054,\n \"sequence_number\": 150,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"ANY\"\n ],\n \"destination_groups\": [\n \"ANY\"\n ],\n \"services\": [\n \"ANY\"\n ],\n \"logged\": true,\n \"scope\": [\n \"ANY\"\n ],\n \"disabled\": true,\n \"direction\": \"IN\",\n \"ip_protocol\": \"IPV4_IPV6\",\n \"is_default\": false,\n \"_system_owned\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1582798600676,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1582799077647,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 5\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "create or update IDS rule",
"description": "Update intrusion detection system rule.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdateIdsRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"description": "Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp1/rules/rule2\n\n {\n \"action\": \"DETECT\",\n \"ids_profiles\": [\"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\"],\n \"disabled\": true,\n \"display_name\": \"Test-Rule\",\n \"logged\": true,\n \"direction\": \"OUT\",\n \"sequence_number\": 100,\n \"source_groups\": [\"/infra/domains/default/groups/Empty_Group\"],\n \"destination_groups\": [\"/infra/domains/default/groups/Empty_Group\"],\n \"scope\": [\"/infra/domains/default/groups/Empty_Group\"]\n}\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-vmw-nsx-example-response": "{\n \"action\": \"DETECT\",\n \"ids_profiles\": [\n \"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\"\n ],\n \"resource_type\": \"IdsRule\",\n \"id\": \"rule2\",\n \"display_name\": \"Test-Rule2\",\n \"path\": \"/infra/domains/default/intrusion-service-policies/sp1/rules/rule2\",\n \"relative_path\": \"rule2\",\n \"parent_path\": \"/infra/domains/default/intrusion-service-policies/sp1\",\n \"unique_id\": \"0cafabf6-aa45-4b3d-a155-6fbd0ce2dbcd\",\n \"marked_for_delete\": false,\n \"sequence_number\": 100,\n \"sources_excluded\": false,\n \"destinations_excluded\": false,\n \"source_groups\": [\n \"/infra/domains/default/groups/Empty_Group\"\n ],\n \"destination_groups\": [\n \"/infra/domains/default/groups/Empty_Group\"\n ],\n \"logged\": true,\n \"scope\": [\n \"/infra/domains/default/groups/Empty_Group\"\n ],\n\"disabled\": true,\n\"direction\": \"OUT\",\n\"_create_user\": \"admin\",\n\"_create_time\": 1563266289276,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1563266289281,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 4\n}\n",
"x-codegen-request-body-name": "IdsRule"
},
"delete": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Delete IDS rule",
"description": "Delete intrusion detection rule.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteIdsRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"description": "Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp1/rules/rule1\n",
"x-vmw-nsx-module": "PolicyIDS"
},
"patch": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Rules"
],
"summary": "Patch IDS rule",
"description": "Patch intrusion detection system rule.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchIdsRule",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy-id",
"in": "path",
"description": "Policy ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"description": "Rule ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdsRule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp1/rules/rule2\n\n {\n \"action\": \"DETECT\",\n \"ids_profiles\": [\"/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile\"],\n \"disabled\": true,\n \"display_name\": \"Test-Rule\",\n \"logged\": true,\n \"direction\": \"OUT\",\n \"sequence_number\": 100,\n \"source_groups\": [\"/infra/domains/default/groups/Empty_Group\"],\n \"destination_groups\": [\"/infra/domains/default/groups/Empty_Group\"],\n \"scope\": [\"/infra/domains/default/groups/Empty_Group\"]\n}\n",
"x-vmw-nsx-module": "PolicyIDS",
"x-codegen-request-body-name": "IdsRule"
}
},
"/error-resolver/{error_id}": {
"get": {
"tags": [
"System Administration",
"Monitoring",
"Error Resolver"
],
"summary": "Fetches metadata about the given error_id",
"description": "Returns some metadata about the given error_id. This includes\ninformation of whether there is a resolver present for the\ngiven error_id and its associated user input data\n",
"operationId": "GetErrorResolverInfo",
"parameters": [
{
"name": "error_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResolverInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/error-resolver/1002\n",
"x-vmw-nsx-module": "ErrorResolver",
"x-vmw-nsx-example-response": "{\n \"user_metadata\": {\n \"user_input_list\": [\n {\n \"property_value\": \"1000\",\n \"property_name\": \"connectTimeout\",\n \"data_type\": \"NUMBER\"\n }\n ]\n },\n \"error_id\": 1002,\n \"resolver_present\": true\n}\n"
}
},
"/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-0 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get tier-0 interface statistics summary information",
"description": "Get tier-0 interface statistics summary information.\n",
"operationId": "GetTier0InterfaceStatisticsSummary",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interface-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatisticsSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-63/interfaces/1-policyconnectivity-450/statistics/summmary?enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"tx\": {\n \"dropped_packets\": 10,\n \"total_bytes\": 12172280,\n \"total_packets\": 60789\n },\n \"last_update_timestamp\": 1457125987869,\n \"rx\": {\n \"dropped_packets\": 8535,\n \"total_bytes\": 2085660,\n \"total_packets\": 33952\n },\n \"logical_router_port_id\": \"9b2ec1c5-cb54-4d69-8d64-14ccad6ae3cf\",\n \"interface_policy_path\": \"/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-63/interfaces/1-policyconnectivity-450\"\n}\n"
}
},
"/infra/segments/service-segments/{service-segment-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Service Segments"
],
"summary": "Read Service Segment",
"description": "Read a Service Segment with the given id",
"operationId": "ReadServiceSegment",
"parameters": [
{
"name": "service-segment-id",
"in": "path",
"description": "Service Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceSegment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/service-segments/service-segment-1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"transport_zone_path\": \"/infra/sites/default/enforcement-points/default/transport-zones/be553b11-040b-4a51-870d-c32fced0ba7d\",\n \"resource_type\": \"ServiceSegment\",\n \"id\": \"service-segment-1\",\n \"display_name\": \"service-segment-1\",\n \"path\": \"/infra/segments/service-segments/service-segment-1\",\n \"relative_path\": \"service-segment-1\",\n \"parent_path\": \"/infra/segments/service-segments/service-segment-1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1543227416946,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1543227416946,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n# When logical router paths are present\nexample_request: |\n GET https://<policy-mgr>/policy/api/v1/infra/segments/service-segments/service-segment-with-lr-paths\nexample_response: |\n{\n \"transport_zone_path\": \"/infra/sites/default/enforcement-points/default/transport-zones/be553b11-040b-4a51-870d-c32fced0ba7d\",\n \"lr_paths\": [\n \"/infra/tier-1s/it_t1\",\n \"/infra/tier-0s/pepsi\"\n ],\n \"resource_type\": \"ServiceSegment\",\n \"id\": \"service-segment-1\",\n \"display_name\": \"service-segment-1\",\n \"path\": \"/infra/segments/service-segments/service-segment-1\",\n \"relative_path\": \"service-segment-1\",\n \"parent_path\": \"/infra/segments/service-segments/service-segment-1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1543227416946,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1543227416946,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Service Segments"
],
"summary": "Create service segment",
"description": "A service segment with the service-segment-id is created.\nModification of service segment is not supported.\n",
"operationId": "CreateServiceSegment",
"parameters": [
{
"name": "service-segment-id",
"in": "path",
"description": "Service Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceSegment"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceSegment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/segments/service-segments/service-segment-1\n{\n \"display_name\": \"service-segment-1\",\n \"resource_type\": \"ServiceSegment\",\n \"transport_zone_path\": \"/infra/sites/default/enforcement-points/default/transport-zones/be553b11-040b-4a51-870d-c32fced0ba7d\"\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ServiceSegment\",\n \"id\": \"service-segment-1\",\n \"display_name\": \"service-segment-1\",\n \"path\": \"/infra/segments/service-segments/service-segment-1\",\n \"relative_path\": \"service-segment-1\",\n \"parent_path\": \"/infra/segments/service-segments/service-segment-1\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1543227599024,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1543227599024,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "ServiceSegment"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Service Segments"
],
"summary": "Delete Service Segment",
"description": "Delete Service Segment with given ID",
"operationId": "DeleteServiceSegment",
"parameters": [
{
"name": "service-segment-id",
"in": "path",
"description": "Service Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/segments/service-segments/service-segment-1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Service Segments"
],
"summary": "Create a service segment",
"description": "A service segment with the service-segment-id is created.\nModification of service segment is not supported.\n",
"operationId": "PatchServiceSegment",
"parameters": [
{
"name": "service-segment-id",
"in": "path",
"description": "Service Segment ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceSegment"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/segments/service-segments/service-segment-with-invalid-lr-path\n{\n \"display_name\": \"service-segment-1\",\n \"resource_type\": \"ServiceSegment\",\n \"transport_zone_path\": \"/infra/sites/default/enforcement-points/default/transport-zones/be553b11-040b-4a51-870d-c32fced0ba7d\",\n \"lr_paths\": [\n \"abc\"\n ]\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "ServiceSegment"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/members/pods": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get pods that belong to this Group",
"description": "Get pods that belong to this Group. This API is applicable for Groups\ncontaining either Pod, Cluster, Namespace, Service member type. For\nGroups containing other member types an empty list is returned\n",
"operationId": "GetGroupPodMembers",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster_id",
"in": "query",
"description": "Cluster ID",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContainerGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/pods?enforcement_point_path=/infra/sites/default/enforcement-points/default&cluster_id=6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"cluster_id\":\"6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"pods\":[\n {\n \"id\": \"4a5a3cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"Container1\"\n },\n {\n \"id\": \"54R3W356-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"Container2\"\n }\n ]\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/global-infra/tier-0s/{tier-0-id}/groups/{group-id}/members/virtual-machines": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get Virtual machines that belong to this Tier-0 Group",
"description": "Get Virtual machines that belong to this Tier-0 Group.\nThis API is applicable for Groups containing VirtualMachine member type.\nFor Groups containing other member types,an empty list is returned.\n",
"operationId": "GlobalInfraGetProviderGroupVMMembers",
"parameters": [
{
"name": "tier-0-id",
"in": "path",
"description": "Tier-0 id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealizedVirtualMachineListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/t1/groups/g1/members/virtual-machines?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"RealizedVirtualMachine\",\n \"id\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"display_name\": \"1-vm_ubuntu_1404_srv_64-local-586-bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"path\": \"/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564de333-15ac-de52-da90-974fe099a17b\",\n \"parent_path\": \"/infra/realized-state/enforcement-points/nsx-1\",\n \"relative_path\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"intent_reference\": [],\n \"realization_specific_identifier\": \"564de333-15ac-de52-da90-974fe099a17b\",\n \"alarms\": [],\n \"state\": \"REALIZED\",\n \"runtime_status\": \"UNKNOWN\",\n \"compute_ids\": [\n \"moIdOnHost:1\",\n \"hostLocalId:1\",\n \"locationId:564de333-15ac-de52-da90-974fe099a17b\",\n \"instanceUuid:bb9bbaf4-7f29-4e7a-9216-ef33890bf081\",\n \"externalId:564de333-15ac-de52-da90-974fe099a17b\",\n \"biosUuid:564de333-15ac-de52-da90-974fe099a17b\"\n ],\n \"power_state\": \"vm_running\",\n \"_create_user\": \"system\",\n \"_create_time\": 1519383616259,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1519383616259,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/firewall-identity-stores/{firewall-identity-store-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Read firewall identity store",
"description": "Return a firewall identity store based on the store identifier\n
\n
Use the following Policy API -
GET /infra/identity-firewall-stores/<identity-firewall-store-id>",
"operationId": "ReadFirewallIdentityStore",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "firewall identity store ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryDomain"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"name\": \"nimbustest1.com\",\n \"base_distinguished_name\": \"DC=nimbustest1,DC=com\",\n \"netbios_name\": \"NIMBUSTEST1\",\n \"sync_settings\": {\n \"delta_sync_interval\": 100,\n \"sync_delay_in_sec\": 30\n },\n \"selective_sync_settings\": {\n \"enabled\": true,\n \"selected_org_units\": [\n \"OU=SELECTIVE22,OU=SELECTIVE1,DC=nimbustest1,DC=com\",\n \"OU=SELECTIVE21,OU=SELECTIVE1,DC=nimbustest1,DC=com\"\n ]\n },\n \"ldap_servers\": [\n {\n \"domain_name\": \"nimbustest1.com\",\n \"host\": \"10.198.41.44\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"username\": \"dummy\",\n \"marked_for_delete\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"resource_type\": \"DirectoryAdDomain\",\n \"id\": \"idstore-1\",\n \"display_name\": \"NIMBUS TEST\",\n \"description\": \"Active directory domain nimbustest.com\",\n \"path\": \"/infra/firewall-identity-stores/idstore-1\",\n \"relative_path\": \"idstore-1\",\n \"parent_path\": \"/infra/firewall-identity-stores/idstore-1\",\n \"unique_id\": \"72acb626-d7a4-4fa0-b01e-c6beb3495a89\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1572444068082,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1572444068082,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Create or update a firewall identity store",
"description": "If a firewall identity store with the firewall-identity-store-id\n is not already present, create a new firewall identity store. If it\nalready exists, replace the firewall identity store instance with\nthe new object.\n\n
\n
Use the following Policy API -
PUT /infra/identity-firewall-stores/<identity-firewall-store-id>",
"operationId": "CreateOrReplaceFirewallIdentityStore",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "firewall identity store ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryDomain"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryDomain"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1\n {\n \"name\": \"nimbustest1.com\",\n \"base_distinguished_name\": \"DC=nimbustest1,DC=com\",\n \"netbios_name\": \"NIMBUSTEST1\",\n \"description\": \"Active directory domain nimbustest.com\",\n \"display_name\": \"NIMBUS TEST\",\n \"ldap_servers\": [\n {\n \"username\": \"dummy\",\n \"password\": \"xxxxxx\",\n \"display_name\": \"nimbus ldap\",\n \"host\": \"10.198.41.44\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"port\": 389,\n \"protocol\": \"LDAP\"\n }\n ],\n \"selective_sync_settings\": {\n \"enabled\": true,\n \"selected_org_units\": [\n \"OU=SELECTIVE21,OU=SELECTIVE1,DC=nimbustest1,DC=com\",\n \"OU=SELECTIVE22,OU=SELECTIVE1,DC=nimbustest1,DC=com\"\n ]\n },\n \"sync_settings\": {\n \"delta_sync_interval\": 100\n }\n }\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-vmw-nsx-example-response": "{\n \"name\": \"nimbustest1.com\",\n \"base_distinguished_name\": \"DC=nimbustest1,DC=com\",\n \"netbios_name\": \"NIMBUSTEST1\",\n \"sync_settings\": {\n \"delta_sync_interval\": 100,\n \"sync_delay_in_sec\": 30\n },\n \"selective_sync_settings\": {\n \"enabled\": true,\n \"selected_org_units\": [\n \"OU=SELECTIVE22,OU=SELECTIVE1,DC=nimbustest1,DC=com\",\n \"OU=SELECTIVE21,OU=SELECTIVE1,DC=nimbustest1,DC=com\"\n ]\n },\n \"ldap_servers\": [\n {\n \"domain_name\": \"nimbustest1.com\",\n \"host\": \"10.198.41.44\",\n \"port\": 389,\n \"protocol\": \"LDAP\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"username\": \"dummy\",\n \"marked_for_delete\": false,\n \"_protection\": \"NOT_PROTECTED\"\n }\n ],\n \"resource_type\": \"DirectoryAdDomain\",\n \"id\": \"idstore-1\",\n \"display_name\": \"NIMBUS TEST\",\n \"description\": \"Active directory domain nimbustest.com\",\n \"path\": \"/infra/firewall-identity-stores/idstore-1\",\n \"relative_path\": \"idstore-1\",\n \"parent_path\": \"/infra/firewall-identity-stores/idstore-1\",\n \"unique_id\": \"72acb626-d7a4-4fa0-b01e-c6beb3495a89\",\n \"marked_for_delete\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1572444068082,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1572444068082,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "DirectoryDomain"
},
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Invoke full sync or delta sync for a specific domain, with\nadditional delay in seconds if needed. Stop sync will try\nto stop any pending sync if any to return to idle state.\n",
"description": "Invoke full sync or delta sync for a specific domain, with\nadditional delay in seconds if needed. Stop sync will try\nto stop any pending sync if any to return to idle state.\n",
"operationId": "RequestFirewallIdentityStoreSync",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "Firewall identity store identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"description": "Sync type requested",
"required": true,
"schema": {
"type": "string",
"enum": [
"FULL_SYNC",
"DELTA_SYNC",
"STOP_SYNC"
]
}
},
{
"name": "delay",
"in": "query",
"description": "Request to execute the sync with some delay in seconds",
"schema": {
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-ip>/policy/api/v1/infra/firewall-identity-stores/123e4567-e89b-12d3-a456-42665544000?action=FULL_SYNC&delay=100\n",
"x-vmw-nsx-module": "PolicyIdentity"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Delete firewall identity store",
"description": "If the firewall identity store is removed, it will stop the identity\nstore synchronization. User will not be able to define new IDFW rules\n\n
\n
Use the following Policy API -
DELETE /infra/identity-firewall-stores/<identity-firewall-store-id>",
"operationId": "DeleteFirewallIdentityStore",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "firewall identity store ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1\n",
"x-vmw-nsx-module": "PolicyIdentity"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Settings",
"Firewall Identity Store"
],
"summary": "Create or update a firewall identity store",
"description": "If a firewall identity store with the firewall-identity-store-id\nis not already present, create a new firewall identity store. If it\nalready exists, update the firewall identity store with specified\nattributes.\n\n
\n
Use the following Policy API -
PATCH /infra/identity-firewall-stores/<identity-firewall-store-id>",
"operationId": "CreateOrPatchFirewallIdentityStore",
"parameters": [
{
"name": "firewall-identity-store-id",
"in": "path",
"description": "firewall identity store ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DirectoryDomain"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/idstore-1\n {\n \"name\": \"nimbustest1.com\",\n \"base_distinguished_name\": \"DC=nimbustest1,DC=com\",\n \"netbios_name\": \"NIMBUSTEST1\",\n \"description\": \"Active directory domain nimbustest.com\",\n \"display_name\": \"NIMBUS TEST\",\n \"resource_type\": \"DirectoryAdDomain\",\n \"ldap_servers\": [\n {\n \"username\": \"dummy\",\n \"password\": \"xxxxxx\",\n \"display_name\": \"nimbus ldap\",\n \"host\": \"10.198.41.44\",\n \"thumbprint\": \"3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e\",\n \"port\": 389,\n \"protocol\": \"LDAP\"\n }\n ],\n \"event_log_servers\": [\n {\n \"domain_name\": \"abc\",\n \"host\": \"10.198.41.88\",\n \"username\": \"test\",\n \"password\": \"xxx\"\n }\n ]\n \"selective_sync_settings\": {\n \"enabled\": true,\n \"selected_org_units\": [\n \"OU=SELECTIVE21,OU=SELECTIVE1,DC=nimbustest1,DC=com\",\n \"OU=SELECTIVE22,OU=SELECTIVE1,DC=nimbustest1,DC=com\"\n ]\n },\n \"sync_settings\": {\n \"delta_sync_interval\": 100\n }\n }\n",
"x-vmw-nsx-module": "PolicyIdentity",
"x-codegen-request-body-name": "DirectoryDomain"
}
},
"/infra/services/{service-id}": {
"get": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Read a service",
"description": "Read a service",
"operationId": "ReadServiceForTenant",
"parameters": [
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/services/my-http\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Service\",\n \"description\": \"My HTTP\",\n \"id\": \"my-http\",\n \"display_name\": \"My HTTP\",\n \"path\": \"/infra/services/my-http\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"my-http\",\n \"service_entries\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"MyHttpEntry\",\n \"display_name\": \"MyHttpEntry\",\n \"path\": \"/infra/services/my-http/service-entries/MyHttpEntry\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"MyHttpEntry\",\n \"destination_ports\": [\n \"8080\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677617,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677617,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Create or update a Service",
"description": "Create a new service if a service with the given ID does not already\nexist. Creates new service entries if populated in the service.\nIf a service with the given ID already exists, update the service\nincluding the nested service entries. This is a full replace.\n",
"operationId": "UpdateServiceForTenant",
"parameters": [
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/services/my-http\n{\n \"description\": \"My HTTP\",\n \"display_name\": \"My HTTP\",\n \"_revision\": 0,\n \"service_entries\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"display_name\": \"MyHttpEntry\",\n \"destination_ports\": [\n \"8080\"\n ],\n \"l4_protocol\": \"TCP\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Service\",\n \"description\": \"My HTTP\",\n \"id\": \"my-http\",\n \"display_name\": \"My HTTP\",\n \"path\": \"/infra/services/my-http\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"my-http\",\n \"service_entries\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"MyHttpEntry\",\n \"display_name\": \"MyHttpEntry\",\n \"path\": \"/infra/services/my-http/service-entries/MyHttpEntry\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"MyHttpEntry\",\n \"destination_ports\": [\n \"8080\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677617,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677617,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677604,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "Service"
},
"delete": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Delete Service",
"description": "Delete Service",
"operationId": "DeleteServiceForTenant",
"parameters": [
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/services/my-http\n",
"x-vmw-nsx-module": "Policy"
},
"patch": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "Patch a Service",
"description": "Create a new service if a service with the given ID does not already\nexist. Creates new service entries if populated in the service.\nIf a service with the given ID already exists, patch the service\nincluding the nested service entries.\n",
"operationId": "PatchServiceForTenant",
"parameters": [
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/services/my-http\n{\n \"description\": \"My HTTP Patched\",\n \"display_name\": \"My HTTP\",\n \"service_entries\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"display_name\": \"MyHttpEntry\",\n \"destination_ports\": [\n \"8080\"\n ],\n \"l4_protocol\": \"TCP\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "Policy",
"x-codegen-request-body-name": "Service"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Interfaces",
"Statistics"
],
"summary": "Get statistics for downlink router port on tier-1 router",
"description": "Segment ID is the ID of the segment that is connected to the the tier-1\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetDownlinkPortStatisticsSummaryForTier1Segment",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInterfaceStatisticsSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH/gateway-interface-statistics/summary\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "{\n \"interface_policy_path\": \"/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH\",\n \"last_update_timestamp\": 1591854157020,\n \"rx\": {\n \"total_bytes\": 314886932,\n \"total_packets\": 678919,\n \"dropped_packets\": 151381\n },\n \"tx\": {\n \"total_bytes\": 75554376,\n \"total_packets\": 1130225,\n \"dropped_packets\": 151381\n },\n \"logical_router_port_id\": \"cbac60fb-841f-4d29-951b-500f527bda34\"\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Get L2VPN service under Tier-1",
"description": "Get L2VPN service for given Tier-1.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetTier1VpnL2VPNService",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-1s/cgw/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Create or fully replace L2VPN service under Tier-1",
"description": "Create or fully replace L2VPN service for given Tier-1. Revision is optional for creation and required for update.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrUpdateTier1VpnL2VPNService",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n{\n \"enable_hub\" : true,\n \"_revision\" : 2\n}\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-vmw-nsx-example-response": "{\n \"resource_type\" : \"L2VPNService\",\n \"path\" : \"/infra/tier-0s/ext_net/l2vpn-services/default\",\n \"enable_hub\" : true,\n \"mode\" : \"SERVER\",\n \"_create_time\" : 1517293097281,\n \"_last_modified_user\" : \"admin\",\n \"_last_modified_time\" : 1517293097281,\n \"_system_owned\" : false,\n \"_create_user\" : \"admin\",\n \"_protection\" : \"NOT_PROTECTED\",\n \"_revision\" : 3\n}\n",
"x-codegen-request-body-name": "L2VPNService"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Delete L2VPN service under Tier-1",
"description": "Delete L2VPN service for given Tier-1.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteTier1VpnL2VPNService",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Services"
],
"summary": "Create or patch L2VPN service under Tier-1",
"description": "Create or patch L2VPN service for given Tier-1.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrPatchTier1VpnL2VPNService",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default\n{\n \"enable_hub\": true,\n}\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-codegen-request-body-name": "L2VPNService"
}
},
"/infra/domains/{domain-id}/security-policies/{security-policy-id}/statistics": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Statistics"
],
"summary": "Get security policy statistics",
"description": "Get statistics of a security policy.\n- no enforcement point path specified: Stats will be evaluated on each enforcement\npoint.\n- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.\n",
"operationId": "GetSecurityPolicyStatistics",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"description": "Security policy id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "container_cluster_path",
"in": "query",
"description": "String Path of the Container Cluster entity",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityPolicyStatisticsListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/web-domain/communciation-maps/emergency/statistics?enforcement_point_path=/infra/deployment-zones/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"results\" : [\n {\n \"rule\": \"ce-1\",\n \"packet_count\": 3806,\n \"session_count\": 819,\n \"hit_count\": 45,\n \"byte_count\": 322989,\n \"popularity_index\": 85,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n },\n {\n \"rule\": \"ce-2\",\n \"packet_count\": 8762,\n \"session_count\": 62,\n \"hit_count\": 45,\n \"byte_count\": 76201,\n \"popularity_index\": 13,\n \"max_popularity_index\": 85,\n \"max_session_count\": 819,\n \"total_session_count\": 881\n }\n ],\n \"cursor\" : 1,\n \"result_count\" : 2\n}\n"
}
},
"/alb/controller-nodes/form-factors": {
"get": {
"tags": [
"System Administration",
"Configuration",
"NSX Advanced Load Balancer",
"Controller",
"Form Factors"
],
"summary": "List available Advanced Load Balancer controller form factors",
"description": "Returns information about all form factors available for Advanced Load Balancer controller nodes.\n",
"operationId": "ListALBControllerFormFactors",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ALBControllerNodeFormFactors"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<ip>/api/v1/alb/controller-nodes/form-factors\n",
"x-vmw-nsx-module": "PolicyALBControllerDeployment",
"x-vmw-nsx-example-response": "{\n \"form_factors\": [\n {\n \"type\": \"SMALL\",\n \"memory\": 24,\n \"vcpu\": 8,\n \"disk\" : 128\n },\n {\n \"type\": \"MEDIUM\",\n \"memory\": 32,\n \"vcpu\": 16,\n \"disk\" : 256\n },\n {\n \"type\": \"LARGE\",\n \"memory\": 48,\n \"vcpu\": 24,\n \"disk\" : 512\n }\n ]\n}\n"
}
},
"/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Monitoring Profile Binding"
],
"summary": "List Infra Segment Monitoring Profile Binding Maps",
"description": "API will list all Infra Segment Monitoring Profile Binding Maps in current segment id.\n",
"operationId": "ListInfraSegmentMonitoringBindings",
"parameters": [
{
"name": "infra-segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentMonitoringProfileBindingMapListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/segments/segment_1/segment-monitoring-profile-binding-maps\n",
"x-vmw-nsx-module": "PolicyMonitoringProfileBinding",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"SegmentMonitoringProfileBindingMap\",\n \"description\": \"\",\n \"name\":\"1\",\n \"id\":\"1\",\n \"display_name\": \"SegmentMonitoringProfileBindingMap\",\n \"path\": \"/infra/segments/segment_1/segment-monitoring-profile-binding-maps/1\",\n \"relative_path\": \"SegmentMonitoringProfileBindingMaps\",\n \"port_mirroring_profile_path\":\"/infra/port-mirroring-profiles/1\",\n \"ipfix_l2_profile_path\":\"/infra/ipfix-l2-profiles/1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n }\n ]\n}\n"
}
},
"/global-infra/traceflows/{traceflow-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Read traceflow config",
"description": "Read traceflow config with id traceflow-id. This configuration\nwill be cleaned up by the system after two hours of inactivity.\n",
"operationId": "GlobalInfraReadTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TraceflowConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/traceflows/t1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"segment_port_path\": \"/infra/tier-1s/it_t1/segments/it-t1-seg/ports/default:c8d7ac3f-1904-4088-a9ec-f0183b5b14d6\",\n \"packet\": {\n \"eth_header\": {\n \"src_mac\": \"00:50:56:8f:49:60\",\n \"dst_mac\": \"00:50:56:8f:2f:97\",\n \"eth_type\": 2048\n },\n \"ip_header\": {\n \"src_ip\": \"172.16.14.11\",\n \"dst_ip\": \"172.16.16.13\",\n \"protocol\": 1,\n \"ttl\": 64,\n \"flags\": 0\n },\n \"transport_header\": {\n \"icmp_echo_request_header\": {\n \"id\": 0,\n \"sequence\": 0\n }\n },\n \"payload\": \"\",\n \"resource_type\": \"FieldsPacketData\",\n \"frame_size\": 128,\n \"routed\": true,\n \"transport_type\": \"UNICAST\"\n },\n \"timeout\": 10,\n \"resource_type\": \"TraceflowConfig\",\n \"id\": \"t7\",\n \"display_name\": \"t7\",\n \"path\": \"/infra/traceflows/t7\",\n \"relative_path\": \"t7\",\n \"parent_path\": \"/infra\",\n \"unique_id\": \"4dbe1a62-156c-46be-a70f-ea237344f1c3\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579195094519,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579195094519,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"Traceflow"
],
"summary": "Delete traceflow config",
"description": "Delete traceflow config with id traceflow-id",
"operationId": "GlobalInfraDeleteTraceflowConfig",
"parameters": [
{
"name": "traceflow-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/traceflows/t1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{}\n"
}
},
"/infra/routing-config/project-route-filters/{route-filter-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Routing",
"Project Route Filters"
],
"summary": "Read a project route filter",
"description": "Read a project route filter",
"operationId": "ReadProjectRouteFilter",
"parameters": [
{
"name": "route-filter-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRouteFilter"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/project-route-filters/route-filter-id\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Routing",
"Project Route Filters"
],
"summary": "Create or update project route filter",
"description": "Create or update a route filter\n",
"operationId": "PutProjectRouteFilter",
"parameters": [
{
"name": "route-filter-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRouteFilter"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRouteFilter"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/routing-config/project-route-filters/route-filter-id\n{\n \"match_prefix_list\" : [\"/infra/routing-config/prefix-lists/p1\"],\n \"projects_list\": [\"/orgs/default/projects/Sales_project\"]\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"match_prefix_list\" : [\"/infra/routing-config/prefix-lists/p1\"],\n \"projects_list\": [\"/orgs/default/projects/Sales_project\"]\n}\n",
"x-codegen-request-body-name": "ProjectRouteFilter"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Routing",
"Project Route Filters"
],
"summary": "Delete a route filter",
"description": "Delete a route filter",
"operationId": "DeleteProjectRouteFilter",
"parameters": [
{
"name": "route-filter-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/routing-config/project-route-filters/route-filter-id\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Routing",
"Project Route Filters"
],
"summary": "Create or patch a route filter",
"description": "Create or patch a route filter. This will create a mapping of projects to prefix lists. Prefix lists will be\napplied to all T-1 under the specified projects.\n",
"operationId": "PatchProjectRouteFilter",
"parameters": [
{
"name": "route-filter-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectRouteFilter"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/routing-config/project-route-filters/route-filter-id\n{\n \"projects_list\": [\"/orgs/org-1/projects/project-1\"],\n \"match_prefix_list\" : [\"/infra/routing-config/prefix-lists/list-1\", \"/infra/routing-config/prefix-lists/list-2\"]\n}\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "200 OK",
"x-codegen-request-body-name": "ProjectRouteFilter"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/members/logical-ports": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get logical ports that belong to this Group",
"description": "Get logical ports that belong to this Group\nThis API is applicable for Groups containing either VirtualMachine, VIF,\nSegment or Segment Port member type.For Groups containing other\nmember types,an empty list is returned.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGroupLPMembers",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/logical-ports?enforcement_point_path=/infra/sites/default/enforcement-points/ep1\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n \"id\" : \"20c1ac1f-58b5-4241-a352-f8e82c4a8c65\",\n \"display_name\" : \"LP-HR1\"\n },\n {\n \"id\" : \"c07005fe-4a9a-47f1-9a1e-2db65a285124\",\n \"display_name\" : \"LP-HR2\"\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/import?action=cancel": {
"post": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Task"
],
"summary": "Cancel a running import task",
"description": "This operation cancels an import task. Task needs to be in running state.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCancelImportTask",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/import?action=cancel\n",
"x-vmw-nsx-module": "PolicyTask",
"x-vmw-nsx-example-response": "{\n \"id\": \"import_task\",\n \"status\": \"canceled\",\n \"description\": \"Import of fw_config_apr2020.zip\",\n \"draft_path\": \"/infra/drafts/imported_fw_config_apr2020\"\n \"failure_msg\": null,\n \"user\": \"admin\",\n \"start_time\": 1587491995996\n}\n"
}
},
"/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"Forwarding Policies"
],
"summary": "List rules",
"description": "List rules",
"operationId": "ListForwardingRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "forwarding-policy-id",
"in": "path",
"description": "Forwarding map id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardingRuleListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1\n/rules\n",
"x-vmw-nsx-module": "PolicyForwarding",
"x-vmw-nsx-example-response": "{\n {\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [ {\n\"resource_type\": \"ForwardingRule\",\n\"description\": \"s3 rule\",\n\"id\": \"rule-1\",\n\"display_name\": \"rule-1\",\n\"action\":\"FORWARD_TO_UNDERLAY\",\n\"tags\": [],\n\"path\": \"/infra/domains/domain1/forwarding-policies/forwarding-policy-1000/rules/forwarding-rule-1\",\n\"relative_path\": \"rule-1\",\n\"sequence_number\": 0,\n\"source_groups\": [\n \"/infra/domains/domain1/groups/srcgrp\"\n],\n\"services\": [\n \"ANY\"\n ],\n\"logged\": false,\n\"destination_groups\": [\n \"/infra/domains/default/groups/S3\"\n],\n\"_create_user\": \"admin\",\n\"_create_time\": 1509362026134,\n\"_last_modified_user\": \"admin\",\n\"_last_modified_time\": 1509362026135,\n\"_system_owned\": false,\n\"_protection\": \"NOT_PROTECTED\",\n\"_revision\": 1,\n\"scope\" : [ \"ANY\" ]\n}]\n}\n"
}
},
"/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "Read a Edge Cluster under an Enforcement Point",
"description": "Read a Edge Cluster under an Enforcement Point\n",
"operationId": "GlobalInfraReadEdgeClusterForEnforcementPoint",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "edge-cluster-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyEdgeCluster"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyEdgeCluster\",\n \"id\": \"ec\",\n \"display_name\": \"/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec\",\n \"path\": \"/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/nsxt-ep\",\n \"relative_path\": \"ec\",\n \"nsx_id\": \"8ce97b79-e2da-4d73-bc3b-4723ccab0600\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262753660,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Tier-1 Gateways",
"Tier-1 Gateways"
],
"summary": "List Tier-1 instances",
"description": "Paginated list of all Tier-1 instances\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListTier1",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tier1ListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"Tier1\",\n \"id\": \"cgw\",\n \"display_name\": \"/infra/tier-1s/cgw\",\n \"path\": \"/infra/tier-1s/cgw\",\n \"parent_path\": \"/infra/tier-1s/cgw\",\n \"relative_path\": \"cgw\",\n \"tier0_path\": \"/infra/tier-0s/vmc_prv\",\n \"force_whitelisting\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668826912,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668826912,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/global-infra/firewall/rules": {
"get": {
"tags": [
"Policy",
"Security"
],
"summary": "Get rules filtered based on the given criteria",
"description": "Get the list of rules of given parent path of policy/section, filtered\nbased on the given criteria.\nParent path is mandatory.\n",
"operationId": "GlobalInfraGetFilteredRules",
"parameters": [
{
"name": "enforcement_point_path",
"in": "query",
"description": "Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "parent_path",
"in": "query",
"description": "Path of the parent object of the entities",
"schema": {
"type": "string"
}
},
{
"name": "scope",
"in": "query",
"description": "Scope filter criteria",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyResourceReferenceForEPListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/firewall/rules?parent_path=/infra/domains/default/security-policies/sp1&scope=6f1c310b-aeed-445e-aef9-9722c8967ab8&enforcement_point_path=/infra/sites/default/enforcement-points/default\n",
"x-vmw-nsx-module": "PolicyFirewallConfiguration",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1/rules/rule1\",\n \"target_id\" : \"rule1\",\n \"target_type\" : \"RULE\",\n \"is_valid\" : \"true\"\n },\n {\n \"path\" : \"/infra/domains/default/security-policies/sp1/rules/rule2\",\n \"target_id\" : \"rule2\",\n \"target_type\" : \"RULE\",\n \"is_valid\" : \"true\"\n }\n }\n ]\n}\n"
}
},
"/infra/settings/firewall/security/intrusion-services/affected-users": {
"post": {
"tags": [
"Policy",
"Security",
"Ids-Ips And Malware",
"Dashboard"
],
"summary": "Get the list of the users affected for that signature",
"description": "Get the list of the users affected pertaining to a specific\nsignature.\n",
"operationId": "GetPolicyAffectedUsers",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsEventDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyIdsUserList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/security/intrusion-services/affected-users\n {\n \"filters\": [\n {\n \"field_names\":\"intrusion_timestamp\",\"value\":\" >1590533447645\"\n },\n {\n \"field_names\": \"signature_detail.signature_id\",\n \"value\": \"(4010643)\"\n }\n ]\n }\n",
"x-vmw-nsx-module": "PolicyIDSMetrics",
"x-vmw-nsx-example-response": "{\n \"results\": [\n \"administrator\",\n \"auditor\"\n ],\n \"result_count\": 2,\n \"sort_by\": \"displayName\",\n \"sort_ascending\": false,\n \"cursor\": \"2\"\n}\n",
"x-codegen-request-body-name": "PolicyIdsEventDataRequest"
}
},
"/infra/segments/{segment-id}/tep-table?format=csv": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"TEP Table"
],
"summary": "Get tier-1 segment TEP table in CSV",
"description": "Returns TEP table for a segment in CSV\n",
"operationId": "GetInfraSegmentTepTableInCsv",
"parameters": [
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Data source type.",
"schema": {
"type": "string",
"enum": [
"realtime",
"cached"
]
}
},
{
"name": "transport_node_id",
"in": "query",
"description": "TransportNode Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PolicyTepCsvListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "https://{{nsx-mgr}}/policy/api/v1/infra/segments/test-infra-seg/tep-table?format=csv&source=realtime\n",
"x-vmw-nsx-module": "PolicyConnectivityStatistics",
"x-vmw-nsx-example-response": "tep_label,tep_ip,tep_mac_address,segment_id\n55298,100.100.100.3,00:50:56:6a:af:ce,\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/services/{service-id}/service-entries": {
"get": {
"tags": [
"Policy",
"Inventory",
"Services"
],
"summary": "List Service entries for the given service",
"description": "Paginated list of Service entries for the given service\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraListServiceEntries",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"description": "Service ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceEntryListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/services/my-http/service-entries\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"MyHttpEntry\",\n \"display_name\": \"MyHttpEntry\",\n \"path\": \"/infra/services/my-http/service-entries/MyHttpEntry\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"MyHttpEntry\",\n \"destination_ports\": [\n \"8080\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517310677617,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517310677617,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"L4PortSetServiceEntry\",\n \"id\": \"https\",\n \"display_name\": \"MyHttps\",\n \"path\": \"/infra/services/my-http/service-entries/https\",\n \"parent_path\": \"/infra/services/my-http\",\n \"relative_path\": \"https\",\n \"destination_ports\": [\n \"7443\"\n ],\n \"l4_protocol\": \"TCP\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517316057383,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517316057383,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ]\n}\n"
}
},
"/infra/deployment-zones/{deployment-zone-id}/enforcement-points/{enforcementpoint-id}": {
"get": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "Read an Enforcement Point",
"description": "Read an Enforcement Point.\n\n
\nThis is a deprecated API. DeploymentZone has been renamed to Site.\nUse GET /infra/sites/site-id/enforcement-points/enforcementpoint-id.\n",
"operationId": "ReadEnforcementPointForInfra",
"parameters": [
{
"name": "deployment-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnforcementPoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/deployment-zones/default/enforcement-points/nsxt-ep\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"EnforcementPoint\",\n \"id\": \"nsxt-ep\",\n \"display_name\": \"/infra/deployment-zones/default/enforcement-points/nsxt-ep\",\n \"path\": \"/infra/deployment-zones/default/enforcement-points/nsxt-ep\",\n \"parent_path\": \"/infra/deployment-zones/default\",\n \"relative_path\": \"nsxt-ep\",\n \"connection_info\": {\n \"resource_type\": \"NSXTConnectionInfo\",\n \"enforcement_point_address\": \"10.192.201.163\",\n \"transport_zone_ids\": [\n \"992759f9-434a-45ea-9347-2ff45fba1f31\"\n ],\n \"edge_cluster_ids\": [\n \"ad79b022-69bd-4bd9-969a-273627690bd9\"\n ],\n \"thumbprint\": \"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\"\n },\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262753660,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n"
},
"put": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "Create/update a new Enforcement Point under infra",
"description": "If the passed Enforcement Point does not already exist, create a new Enforcement Point.\nIf it already exists, replace it.\n\n
\nThis is a deprecated API. DeploymentZone has been renamed to Site.\nUse PUT /infra/sites/site-id/enforcement-points/enforcementpoint-id.\n",
"operationId": "CreateOrUpdateEnforcementPointForInfra",
"parameters": [
{
"name": "deployment-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnforcementPoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnforcementPoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/deployment-zones/default/enforcement-points/nsxt-ep\n{\n \"connection_info\": {\n \"enforcement_point_address\":\"10.192.201.163\",\n \"resource_type\":\"NSXTConnectionInfo\",\n \"username\":\"admin\",\n \"password\":\"Admin!23Admin\",\n \"thumbprint\":\"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\",\n \"transport_zone_ids\": [ \"992759f9-434a-45ea-9347-2ff45fba1f31\" ],\n \"edge_cluster_ids\": [ \"ad79b022-69bd-4bd9-969a-273627690bd9\" ]\n },\n \"_revision\" : 0\n}\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"EnforcementPoint\",\n \"id\": \"nsxt-ep\",\n \"display_name\": \"/infra/deployment-zones/default/enforcement-points/nsxt-ep\",\n \"path\": \"/infra/deployment-zones/default/enforcement-points/nsxt-ep\",\n \"parent_path\": \"/infra/deployment-zones/default\",\n \"relative_path\": \"nsxt-ep\",\n \"connection_info\": {\n \"resource_type\": \"NSXTConnectionInfo\",\n \"enforcement_point_address\": \"10.192.201.163\",\n \"transport_zone_ids\": [\n \"992759f9-434a-45ea-9347-2ff45fba1f31\"\n ],\n \"edge_cluster_ids\": [\n \"ad79b022-69bd-4bd9-969a-273627690bd9\"\n ],\n \"thumbprint\": \"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\"\n },\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "EnforcementPoint"
},
"delete": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "Delete EnforcementPoint",
"description": "Delete EnforcementPoint.\n\n
\nThis is a deprecated API. DeploymentZone has been renamed to Site.\nUse DELETE /infra/sites/site-id/enforcement-points/enforcementpoint-id.\n",
"operationId": "DeleteEnforcementPoint",
"parameters": [
{
"name": "deployment-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/deployment-zones/default/enforcement-points/nsxt-ep\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement"
},
"patch": {
"tags": [
"Policy",
"Infra",
"Enforcement Points"
],
"summary": "Patch a new Enforcement Point under infra",
"description": "If the passed Enforcement Point does not already exist, create a new Enforcement Point.\nIf it already exists, patch it.\n\n
\nThis is a deprecated API. DeploymentZone has been renamed to Site.\nUse PATCH /infra/sites/site-1/enforcement-points/enforcementpoint-1.\n",
"operationId": "PatchEnforcementPointForInfra",
"parameters": [
{
"name": "deployment-zone-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcementpoint-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnforcementPoint"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/deployment-zones/default/enforcement-points/nsxt-ep\n{\n \"connection_info\": {\n \"enforcement_point_address\":\"10.192.201.163\",\n \"resource_type\":\"NSXTConnectionInfo\",\n \"username\":\"admin\",\n \"password\":\"Admin!23Admin\",\n \"thumbprint\":\"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\",\n \"transport_zone_ids\": [ \"992759f9-434a-45ea-9347-2ff45fba1f31\" ],\n \"edge_cluster_ids\": [ \"ad79b022-69bd-4bd9-969a-273627690bd9\" ]\n }\n}\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-codegen-request-body-name": "EnforcementPoint"
}
},
"/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Edge Bridge Profiles"
],
"summary": "List L2 Bridge Endpoint Profiles",
"description": "List all L2 bridge profiles",
"operationId": "ListL2BridgeProfiles",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "site ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement-point-id",
"in": "path",
"description": "enforcement point ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2BridgeEndpointProfileListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-bridge-profiles\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"edge_paths\": [\n \"/infra/sites/default/enforcement-points/default/edge-clusters/05e58fcb-8575-4b20-9c49-3f09a0d70572/edge-nodes/0\"\n ],\n \"ha_mode\": \"ACTIVE_STANDBY\",\n \"failover_mode\": \"PREEMPTIVE\",\n \"resource_type\": \"L2BridgeEndpointProfile\",\n \"id\": \"p2\",\n \"display_name\": \"p2\",\n \"path\": \"/infra/sites/default/enforcement-points/default/edge-bridge-profiles/p2\",\n \"relative_path\": \"p2\",\n \"parent_path\": \"/infra/sites/default/enforcement-points/default\",\n \"unique_id\": \"55971354-aa4b-45dd-bb4f-0a37aaea2181\",\n \"marked_for_delete\": false,\n \"overridden\": false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1579296711399,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1579296711399,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code": {
"post": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"L2VPN",
"Sessions"
],
"summary": "Create or patch an L2VPN session under Tier-1 from Peer Codes",
"description": "Create or patch an L2VPN session under Tier-1 from Peer Codes.\nIn addition to the L2VPN Session, the IPSec VPN Session, along\nwith the IKE, Tunnel, and DPD Profiles are created and owned by\nthe system. IPSec VPN Service and Local Endpoint are created only\nwhen required, i.e., an IPSec VPN Service does not already exist,\nor an IPSec VPN Local Endpoint with same local address does not\nalready exist.\nUpdating the L2VPN Session can be performed only through this API\nby specifying new peer codes. Use of specific APIs to update the\nL2VPN Session and the different resources associated with it is\nnot allowed, except for IPSec VPN Service and Local Endpoint,\nresources that are not system owned.\nAPI supported only when L2VPN Service is in Client Mode.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraCreateOrPatchTier1VpnL2VPNSessionFromPeerCodes",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNSessionData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/l2vpn-services/default/sessions/stretched-pa-site?action=create_with_peer_codes\n{\n \"description\": \"Stretched Palo Alto Site\",\n \"display_name\": \"stretched-pa-site\",\n \"transport_tunnels\": [\n {\n \"peer_code\": \"MCw0YTc2YTNlLHsic2l0ZU5hbWUiOiJwb2xpY3ktc2Vzc2lvbi1QUk9WSURFUi5obWl6YS5wYS1wdW5lLXJiLXZwbiIs\n InNyY1RhcElwIjoiMTY5LjI1NC42NC4yIiwiZHN0VGFwSXAiOiIxNjkuMjU0LjY0LjEiLCJpa2VPcHRpb24iOiJpa2V2\n MiIsImVuY2FwUHJvdG8iOiJncmUvaXBzZWMiLCJkaEdyb3VwIjoiZGgxNCIsImVuY3J5cHRBbmREaWdlc3QiOiJhZXMt\n Z2NtL3NoYS0yNTYiLCJwc2siOiJkZWZhdWx0IiwidHVubmVscyI6W3sibG9jYWxJZCI6IjI0LjI0LjI0LjI0IiwicGVl\n cklkIjoiMTEuMTEuMTEuMTEifV19\",\n \"peer_address\": \"10.10.10.10\",\n \"local_address\": \"20.20.20.20\"\n }\n ]\n}\n",
"x-vmw-nsx-module": "PolicyVpnLayer2VPN",
"x-codegen-request-body-name": "L2VPNSessionData"
}
},
"/infra/sha/dynamic-plugins/{plugin-id}": {
"get": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Read Sha dynamic plugin",
"description": "Read Sha dynamic plugin.\n",
"operationId": "ReadShaDynamicPlugin",
"parameters": [
{
"name": "plugin-id",
"in": "path",
"description": "Plugin filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaDynamicPlugin"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sha/dynamic-plugins/monitor-plugin\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ShaDynamicPlugin\",\n \"id\": \"monitor-plugin\",\n \"display_name\": \"monitor-plugin\",\n \"path\": \"/infra/sha/dynamic-plugins/monitor-plugin\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"monitor-plugin\",\n \"group_path\": \"/infra/domains/d1/groups/group1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Create Sha dynamic plugin",
"description": "Create Sha dynamic plugin.\n",
"operationId": "CreateOrReplaceShaDynamicPlugin",
"parameters": [
{
"name": "plugin-id",
"in": "path",
"description": "Sha plugin id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaDynamicPlugin"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaDynamicPlugin"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/sha/dynamic-plugins/monitor-plugin\n {\n \"display_name\": \"monitor-plugin\",\n \"path\": \"/infra/sha/dynamic-plugins/monitor-plugin\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n }\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ShaDynamicPlugin\",\n \"id\": \"monitor-plugin\",\n \"display_name\": \"monitor-plugin\",\n \"path\": \"/infra/sha/dynamic-plugins/monitor-plugin\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"monitor-plugin\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "ShaDynamicPlugin"
},
"delete": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Delete Sha dynamic plugin",
"description": "Delete Sha dynamic plugin.\n",
"operationId": "DeleteShaDynamicPlugin",
"parameters": [
{
"name": "plugin-id",
"in": "path",
"description": "Plugin filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/sha/dynamic-plugin/monitor-plugin\n",
"x-vmw-nsx-module": "PolicySha"
},
"patch": {
"tags": [
"Policy",
"Monitoring",
"System Health Agent",
"Profile"
],
"summary": "Create or Replace Sha dynamic plugin",
"description": "Create or Replace Sha dynamic plugin.\n",
"operationId": "PatchShaDynamicPlugin",
"parameters": [
{
"name": "plugin-id",
"in": "path",
"description": "Sha plugin id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaDynamicPlugin"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShaDynamicPlugin"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/sha/dynamic-plugins/monitor-plugin\n {\n \"display_name\": \"monitor-plugin-v2\",\n }\n",
"x-vmw-nsx-module": "PolicySha",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ShaDynamicPlugin\",\n \"id\": \"monitor-plugin\",\n \"display_name\": \"monitor-plugin-v2\",\n \"path\": \"/infra/sha/dynamic-plugins/monitor-plugin\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"monitor-plugin\",\n \"applied_to_group_path\": \"/infra/domains/d1/groups/group1\",\n \"is_plugin_uploaded\": true,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517354268091,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517354315280,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "ShaDynamicPlugin"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/members/pods": {
"get": {
"tags": [
"Policy",
"Inventory",
"Groups",
"Group Members"
],
"summary": "Get pods that belong to this Group",
"description": "Get pods that belong to this Group. This API is applicable for Groups\ncontaining either Pod, Cluster, Namespace, Service member type. For\nGroups containing other member types an empty list is returned\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetGroupPodMembers",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "domain-id",
"in": "path",
"description": "Domain id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cluster_id",
"in": "query",
"description": "Cluster ID",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyContainerGroupMembersListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/d1/groups/g1/members/pods?enforcement_point_path=/infra/sites/default/enforcement-points/default&cluster_id=6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\n",
"x-vmw-nsx-module": "PolicyGroupRealization",
"x-vmw-nsx-example-response": "{\n \"results\": [\n {\n \"cluster_id\":\"6ar43cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"pods\":[\n {\n \"id\": \"4a5a3cd0-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"Container1\"\n },\n {\n \"id\": \"54R3W356-6f0a-40b0-a31a-1f55d51e1824\",\n \"display_name\": \"Container2\"\n }\n ]\n }\n ],\n \"result_count\": 1,\n \"sort_by\": \"display_name\",\n \"sort_ascending\": true\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/constraint-global-config": {
"get": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Constraint Global Configuration"
],
"summary": "Read the constraint global configuration",
"description": "Read the constraint global configuration",
"operationId": "OrgsOrgIdProjectsProjectIdInfrareadConstraintGlobalConfig",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstraintGlobalConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/constraint-global-config\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ConstraintGlobalConfig\",\n \"id\": \"constraint-global-config\",\n \"display_name\": \"constraint-global-config\",\n \"path\": \"/infra/constraint-global-config\",\n \"relative_path\": \"constraint-global-config\",\n \"include_system_resources\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1517296394552,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1517296394552,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Constraint Global Configuration"
],
"summary": "Update the constraint global configuration",
"description": "Update the constraint global configuration",
"operationId": "OrgsOrgIdProjectsProjectIdInfraputConstraintGlobalConfig",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstraintGlobalConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstraintGlobalConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/constraint-global-config\n{\n \"display_name\": \"constraint-global-config\",\n \"path\": \"/infra/constraint-global-config\",\n \"relative_path\": \"constraint-global-config\",\n \"include_system_resources\": true,\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "Policy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"ConstraintGlobalConfig\",\n \"id\": \"constraint-global-config\",\n \"display_name\": \"constraint-global-config\",\n \"path\": \"/infra/constraint-global-config\",\n \"relative_path\": \"constraint-global-config\",\n \"include_system_resources\": true,\n \"_create_user\": \"system\",\n \"_create_time\": 1517296394552,\n \"_last_modified_user\": \"system\",\n \"_last_modified_time\": 1517296394552,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "ConstraintGlobalConfig"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Networking Profiles",
"Constraint Global Configuration"
],
"summary": "Update the constraint global configuration",
"description": "Update the constraint global configuration",
"operationId": "OrgsOrgIdProjectsProjectIdInfrapatchConstraintGlobalConfig",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstraintGlobalConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/constraint-global-config\n{\n \"display_name\": \"constraint-global-config\",\n \"path\": \"/infra/constraint-global-config\",\n \"relative_path\": \"constraint-global-config\",\n \"include_system_resources\": true,\n \"_revision\": 0\n}\n",
"x-vmw-nsx-module": "Policy",
"x-codegen-request-body-name": "ConstraintGlobalConfig"
}
},
"/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config": {
"get": {
"tags": [
"Policy",
"Networking",
"Network Services",
"VPN",
"IPSEC",
"Sessions"
],
"summary": "Get IPSec VPN configuration for the peer site",
"description": "Download IPSec VPN configuration for the peer site. Peer config also\ncontains PSK; be careful when sharing or storing it.\n\n
\nThis API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config instead.\nNote:\n Please note that request is validated and any error messages returned from validation may include the new VPN path\n instead of the deprecated path. Both new path and old path refer to same resource.\n",
"operationId": "GetTier1IPSecVpnPeerConfig",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale-service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "service-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "String Path of the enforcement point",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"text/plain; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"deprecated": true,
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1/peer-config\n",
"x-vmw-nsx-module": "PolicyIPSecVpn",
"x-vmw-nsx-example-response": "# Suggestive peer configuration for Policy IPSec VPN\n#\n# IPSec VPN path : /infra/tier-1s/int_net/locale-services/default/ipsec-vpn-services/default/sessions/rbs-1/peer-config\n# IPSec VPN name : rbs-1\n# IPSec VPN description :\n# Tier 1 path : /infra/tier-1s/int_net\n\n\n#\n# Enforcement point path : /infra/deployment-zones/default/enforcement-points/nsxt\n# Enforcement point type : NSXT\n#\n# Suggestive peer configuration for IPSec VPN Connection\n#\n# IPSecVPNSession Id : aafeb845-e2fa-4c86-9f0e-43c5ed3ef707\n# IPSecVPNSession name : PROVIDER.int_net.pa-paris-rb-vpn\n# IPSecVPNSession description:\n# IPSecVPNSession enabled : true\n# IPSecVPNSession type : Route based VPN\n# Logical router Id : d58beabb-853c-473c-ad8d-34bd9c644692\n# Generated Time : Tue Apr 03 14:21:13 GMT 2018\n\n#\n# Internet Key Exchange Configuration [Phase 1]\n# Configure the IKE SA as outlined below\nIKE version : IKE_V2\nConnection initiation mode : INITIATOR\nAuthentication method : PSK\nPre shared key : 12345\nAuthentication algorithm : [SHA2_256]\nEncryption algorithm : [AES_128]\nSA life time : 86400\nNegotiation mode : Not applicable for ikev2\nDH group : [GROUP14]\n\n# IPsec_configuration [Phase 2]\n# Configure the IPsec SA as outlined below\nTransform Protocol : ESP\nAuthentication algorithm : []\nSa life time : 3600\nEncryption algorithm : [AES_GCM_128]\nEncapsulation mode : TUNNEL_MODE\nEnable perfect forward secrecy : true\nPerfect forward secrecy DH group: [GROUP14]\n\n# IPsec Dead Peer Detection (DPD) settings\nDPD enabled : true\nDPD probe interval : 60\n\n# Peer configuration\nPeer address : 88.88.72.22 # Peer gateway public IP.\nPeer id : 88.88.72.22\nPeer Subnet : 0.0.0.0/0\n\n# Local configuration\nLocal address : 44.44.44.46 # Local gateway public IP.\nLocal id : 99.33.33.33\nLocal Subnet : 0.0.0.0/0\n\n# Virtual Tunnel Interface\nPeer VTI address : 192.168.2.1\nLocal VTI address : 192.168.2.11\nTunnel Interface MTU : 1416 bytes\n\n#\n# BGP Configuration\n#\nBGP neighbour IP : 192.168.2.1\nBGP neighbour AS number : 2000\nBGP local IP : 192.168.2.11\nBGP local AS number : 65556\nBGP secret : PolicyRocks\nBGP hold down timer : 180\nBGP keep alive timer : 60\nBFD Status : false\n"
}
},
"/infra/l7-access-profiles/{l7-access-profile-id}/entries": {
"get": {
"tags": [
"Policy",
"Inventory",
"Profiles",
"L7 Access Profiles"
],
"summary": "List l7 access profile entries",
"description": "API will list all l7 access profiles entries",
"operationId": "ListL7AccessEntries",
"parameters": [
{
"name": "l7-access-profile-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "include_mark_for_delete_objects",
"in": "query",
"description": "Include objects that are marked for deletion in results",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L7AccessEntryListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/l7-access-profiles/profile-1/entries\n",
"x-vmw-nsx-module": "L7AccessProfile",
"x-vmw-nsx-example-response": "{\n \"sort_ascending\": true,\n \"sort_by\": \"display_name\",\n \"result_count\": 1,\n \"results\": [\n {\n \"resource_type\": \"L7AccessEntry\",\n \"id\": \"entry-1\",\n \"display_name\": \"entry-1\",\n \"description\":\"Test Policy L7 Access Profile entry\",\n \"path\": \"/infra/l7-access-profiles/profile-1/entries/entry-1\"\n \"relative_path\": \"entry-1\",\n \"marked_for_delete\": false,\"\n \"sequence_number\": 101,\n \"attributes\":[\n {\n \"key\":\"CUSTOM_URL\",\n \"value\": [\n \"*.cisco.com\",\n \"www.google.com\"\n ],\n \"datatype\":\"STRING\",\n \"attribute_source\": \"CUSTOM\"\n }\n ],\n \"action\": \"ALLOW\",\n \"logged\" : false,\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n }\n ]\n}\n"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Get Port Discovery Profile Binding Map",
"description": "API will get Port Discovery Profile Binding Map\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraGetPortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Update Port Discovery Profile Binding Map",
"description": "API will update Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraUpdatePortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n{\n \"resource_type\":\" PortDiscoveryProfileBindingMap\",\n \"display_name\": \"PortDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PortDiscoveryProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"pdpbm_1\",\n \"display_name\": \"PortDiscoveryProfileBindingMap\",\n \"path\": \"/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\",\n \"relative_path\": \"PortDiscoveryProfileBindingMaps\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\",\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PortDiscoveryProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Delete Port Discovery Profile Binding Profile",
"description": "API will delete Port Discovery Profile Binding Profile",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeletePortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Networking",
"Connectivity",
"Segments",
"Segment Profiles",
"Discovery Profile Binding"
],
"summary": "Create Port Discovery Profile Binding Map",
"description": "API will create Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.",
"operationId": "OrgsOrgIdProjectsProjectIdInfraPatchPortDiscoveryBinding",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tier-1-id",
"in": "path",
"description": "Tier-1 ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"description": "Segment ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-id",
"in": "path",
"description": "Port ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "port-discovery-profile-binding-map-id",
"in": "path",
"description": "Port Discovery Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortDiscoveryProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/tier-1s/tier-1/segments/segment_1/ports/port_1/port-discovery-profile-binding-maps/pdpbm_1\n {\n \"resource_type\":\" PortDiscoveryProfileBindingMap\",\n \"display_name\": \"PortDiscoveryProfileBindingMap Profile Production\",\n \"description\":\"\",\n \"mac_discovery_profile_path\":\"/infra/mac-discovery-profiles/macdp_1\",\n \"ip_discovery_profile_path\":\"/infra/ip-discovery-profiles/ipdp_1\"\n }\n",
"x-vmw-nsx-module": "PolicyDiscoveryProfileBinding",
"x-codegen-request-body-name": "PortDiscoveryProfileBindingMap"
}
},
"/infra/domains/{domain-id}/groups/{group-id}/firewall-flood-protection-profile-binding-maps/{firewall-flood-protection-profile-binding-map-id}": {
"get": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Get Firewall Flood Protection Profile Binding Map",
"description": "API will get Firewall Flood Protection Profile Binding Map\n",
"operationId": "GetPolicyFirewallFloodProtectionBinding",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain-ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"binding-map-1\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallFloodProtectionProfileBindingMaps\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Update Firewall Flood Protection Profile Binding Map",
"description": "API will update Firewall Flood Protection Profile Binding Map",
"operationId": "UpdatePolicyFirewallFloodProtectionBinding",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "DomainID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n{\n \"resource_type\":\" PolicyFirewallFloodProtectionProfileBindingMap\",\n \"display_name\": \"binding-map-1\",\n \"description\":\"\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\",\n \"_revision\": 1\n}\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"description\": \"\",\n \"id\":\"1\",\n \"display_name\": \"PolicyFirewallFloodProtectionProfileBindingMap\",\n \"path\": \"/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\",\n \"relative_path\": \"PolicyFirewallFloodProtectionProfileBindingMaps\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n \"_create_user\": \"admin\",\n \"_create_time\": 1516657975538,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517353711231,\n \"_system_owned\": false,\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "PolicyFirewallFloodProtectionProfileBindingMap"
},
"delete": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Delete Firewall Flood Protection Profile Binding",
"description": "API will delete Firewall Flood Protection Profile Binding",
"operationId": "DeletePolicyFirewallFloodProtectionBinding",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding"
},
"patch": {
"tags": [
"Policy",
"Security",
"Security Profiles",
"Flood Protection Profile Binding"
],
"summary": "Create or update Firewall Flood Protection Profile Binding Map",
"description": "API will create or update Firewall Flood Protection profile binding map",
"operationId": "PatchPolicyFirewallFloodProtectionProfileBindingMap",
"parameters": [
{
"name": "domain-id",
"in": "path",
"description": "Domain ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group-id",
"in": "path",
"description": "Group ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firewall-flood-protection-profile-binding-map-id",
"in": "path",
"description": "Firewall Flood Protection Profile Binding Map ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyFirewallFloodProtectionProfileBindingMap"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<nsx-mgr>/policy/api/v1/infra/domains/domain_1/groups/group_1/firewall-flood-protection-profile-binding-maps/1\n {\n \"resource_type\":\" PolicyFirewallFloodProtectionProfileBindingMap\",\n \"display_name\": \"binding-map-1\",\n \"description\":\"\",\n \"profile_path\":\"/infra/flood-protection-profiles/1\"\n }\n",
"x-vmw-nsx-module": "PolicyFirewallFloodProtectionProfileBinding",
"x-codegen-request-body-name": "PolicyFirewallFloodProtectionProfileBindingMap"
}
},
"/global-infra/dhcp-relay-configs/{dhcp-relay-config-id}": {
"get": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Relay Configs"
],
"summary": "Read DHCP relay configuration",
"description": "Read DHCP relay configuration",
"operationId": "GlobalInfraReadDhcpRelayConfig",
"parameters": [
{
"name": "dhcp-relay-config-id",
"in": "path",
"description": "DHCP relay config ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpRelayConfig"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/dhcp-relay-configs/dhcp-relay1\n",
"x-vmw-nsx-module": "PolicyConnectivity",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"DhcpRelayConfig\",\n \"id\": \"dhcp-relay1\",\n \"display_name\": \"dhcp-relay1\",\n \"path\": \"/infra/dhcp-relay-configs/dhcp-relay1\",\n \"parent_path\": \"/infra\",\n \"relative_path\": \"dhcp-relay1\",\n \"server_addresses\": [ \"10.1.1.1\", \"10.1.1.2\" ]\n \"_create_user\": \"admin\",\n \"_create_time\": 1516668826912,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516668826912,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n"
}
},
"/infra/tier-1s/{tier-1-id}/gateway-firewall": {
"get": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Tier-1 Gateways"
],
"summary": "Get list of gateway policies with rules that belong to the specific Tier-1.\n",
"description": "Get filtered view of Gateway Firewall rules associated with the Tier-1.\nThe gateway policies are returned in the order of category and sequence number.\n",
"operationId": "ViewTier1GatewayFirewall",
"parameters": [
{
"name": "tier-1-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicyListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/t1/gateway-firewall\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"internal\",\n \"display_name\": \"internal\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/internal\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"internal\",\n \"sequence_number\": 10,\n \"internal_sequence_number\": 20010,\n \"category\": \"PRE_RULES\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-1s/t1\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469778,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516295469778,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n },\n {\n \"resource_type\": \"GatewayPolicy\",\n \"id\": \"default\",\n \"display_name\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"parent_path\": \"/infra/domains/vmc-domain\",\n \"relative_path\": \"default\",\n \"sequence_number\": 10,\n \"internal_sequence_number\": 20010,\n \"category\": \"POST_RULES\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \"entry1\",\n \"id\": \"entry1\",\n \"display_name\": \"entry1\",\n \"path\": \"/infra/domains/vmc-domain/gateway-policies/default/rules/entry1\",\n \"parent_path\": \"/infra/domains/vmc-domain/gateway-policies/default\",\n \"relative_path\": \"entry1\",\n \"sequence_number\": 0,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/source\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc-domain/groups/destination\"\n ],\n \"scope\": [\n \"/infra/tier-1s/t1/locale-services/locale-1\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516386404233,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516431370604,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 3\n }\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1516295469775,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1516432061800,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 6\n }\n ]\n}\n"
}
},
"/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}?action=revise": {
"post": {
"tags": [
"Policy",
"Security",
"North South Security",
"Gateway Firewall",
"Rules"
],
"summary": "Revise the positioning of gateway policy",
"description": "This is used to set a precedence of a gateway policy w.r.t others.\n",
"operationId": "ReviseGatewayPolicy",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gateway-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "anchor_path",
"in": "query",
"description": "The security policy/rule path if operation is 'insert_after' or\n'insert_before'\n",
"schema": {
"type": "string"
}
},
{
"name": "operation",
"in": "query",
"description": "Operation",
"schema": {
"type": "string",
"default": "insert_top",
"enum": [
"insert_top",
"insert_bottom",
"insert_after",
"insert_before"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicy"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayPolicy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "POST https://<policy-mgr>/policy/api/v1/infra/domains/vmc/gateway-policies/cgw-1?action=revise&anchor_path=/infra/domains/vmc/gateway-policies/cgw-2&operation=insert_before\n{\n \"description\": \"policy revised\",\n \"display_name\": \"cgw-1\",\n \"category\": \"SharedPreRules\",\n \"rules\": [\n {\n \"description\": \" rule\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"scope\": [\n \"/infra/tier-1s/cgw\"\n ],\n \"action\": \"ALLOW\"\n }\n\n ]\n}\n",
"x-vmw-nsx-module": "PolicyEdgeFirewall",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"GatewayPolicy\",\n \"description\": \"comm map revised\",\n \"id\": \"cgw-1\",\n \"display_name\": \"cgw-1\",\n \"path\": \"/infra/domains/vmc/gateway-policies/cgw-1\",\n \"parent_path\": \"/infra/domains/vmc\",\n \"relative_path\": \"cgw-1\",\n \"rules\": [\n {\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/gateway-policies/cgw1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/gateway-policies/cgw1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"/infra/tier-1s/cgw\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n }\n ],\n \"category\": \"SharedPreRules\",\n \"sequence_number\": 0,\n \"internal_sequence_number\": 20000,\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317362027,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317362027,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 0\n}\n",
"x-codegen-request-body-name": "GatewayPolicy"
}
},
"/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}": {
"get": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Read rule",
"description": "Read rule",
"operationId": "ReadSecurityRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n"
},
"put": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Create or update a rule",
"description": "Update the rule. Create new rule if a rule with the rule-id is not already\npresent.\nPerformance Note: If you wish to edit several rules in a security policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/security-policies/<security-policy-id>\n",
"operationId": "UpdateSecurityRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n{\n \"description\": \"comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"DROP\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n],\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Rule\",\n \"description\": \" comm entry\",\n \"id\": \"ce-1\",\n \"display_name\": \"ce-1\",\n \"path\": \"/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\",\n \"parent_path\": \"/infra/domains/vmc/security-policies/application-section-1\",\n \"relative_path\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc/groups/dbgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc/groups/appgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"ALLOW\",\n \"services\": [\n \"/infra/services/HTTP\",\n \"/infra/services/CIM-HTTP\"\n ],\n \"_create_user\": \"admin\",\n \"_create_time\": 1517317382942,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517317382962,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 1\n}\n",
"x-codegen-request-body-name": "Rule"
},
"delete": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Delete rule",
"description": "Delete rule",
"operationId": "DeleteSecurityRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n",
"x-vmw-nsx-module": "DfwSecurityPolicy"
},
"patch": {
"tags": [
"Policy",
"Security",
"East West Security",
"Distributed Firewall",
"Rules"
],
"summary": "Patch a rule",
"description": "Patch the rule. If Rule corresponding to the the given rule-id is\nnot present, the object will get created and if it is present it will be\nupdated. This is a full replace.\nPerformance Note: If you want to edit several rules in a security policy,\nprefer below mentioned API for optimal performance.\nPass all the rules which you wish to edit as embedded rules to it.\nUse this API - PATCH (or PUT)\n/infra/domains/<domain-id>/security-policies/<security-policy-id>\n",
"operationId": "PatchSecurityRule",
"parameters": [
{
"name": "domain-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "security-policy-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rule-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/domains/vmc/security-policies/application-section-1/rules/ce-1\n{\n \"description\": \" comm entry\",\n \"display_name\": \"ce-1\",\n \"sequence_number\": 1,\n \"source_groups\": [\n \"/infra/domains/vmc_domain/groups/webgroup\"\n ],\n \"logged\": false,\n \"destination_groups\": [\n \"/infra/domains/vmc_domain/groups/dbgroup\"\n ],\n \"scope\": [\n \"ANY\"\n ],\n \"action\": \"DROP\",\n \"services\": [\n \"ANY\"\n ]\n}\n",
"x-vmw-nsx-module": "DfwSecurityPolicy",
"x-codegen-request-body-name": "Rule"
}
},
"/aaa/vidm/users": {
"get": {
"tags": [
"System Administration",
"Settings",
"User Management",
"VIDM Configuration"
],
"summary": "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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.",
"description": "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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.",
"operationId": "GetUserVidmSearchResult",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"schema": {
"type": "string"
}
},
{
"name": "included_fields",
"in": "query",
"description": "Comma separated list of fields that should be included in query result",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"in": "query",
"description": "Maximum number of results to return in this page (server may return fewer)",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "search_string",
"in": "query",
"description": "Search string to search for.\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort_ascending",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Field by which records are sorted",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VidmInfoListResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<nsx-mgr>/api/v1/aaa/vidm/users?search_string=John\n",
"x-vmw-nsx-module": "AAA",
"x-vmw-nsx-example-response": "{\n \"result_count\": 2,\n \"results\": [\n {\n \"name\": \"John_doe@testad2.local\",\n \"type\": \"remote_user\",\n \"display_name\": \"John Doe\"\n },\n {\n \"name\": \"John_roe@testad2.local\",\n \"type\": \"remote_user\",\n \"display_name\": \"John Roe\"\n }\n ]\n}\n"
}
},
"/infra/sites/{site-id}": {
"get": {
"tags": [
"Federation",
"Sites"
],
"summary": "Read a site",
"description": "Read a site under Infra.\n",
"operationId": "ReadSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "GET https://<policy-mgr>/policy/api/v1/infra/sites/casablanca\n",
"x-vmw-nsx-module": "PolicyEnforcementPointManagement",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Site\",\n \"id\": \"casablanca\",\n \"display_name\": \"Casablanca, Morocco Site\",\n \"description\" : \"Site managing call center workloads in North Africa\",\n \"path\": \"/infra/sites/casablanca\",\n \"parent_path\": \"/infra/sites/casablanca\",\n \"relative_path\": \"casablanca\",\n \"site_connection_info\": [{\n \"fqdn\": \"10.192.201.163\"\n }],\n \"maximum_rtt\": 250,\n \"fail_if_rtt_exceeded\": true,\n \"fail_if_mismatch_rteps\": true\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n"
},
"put": {
"tags": [
"Federation",
"Sites"
],
"summary": "Create or fully replace a Site under infra",
"description": "Create or fully replace a Site under Infra.\nRevision is optional for creation and required for update.\n",
"operationId": "CreateOrUpdateInfraSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PUT https://<policy-mgr>/policy/api/v1/infra/sites/Paris\n{\n \"site_connection_info\": [{\n \"fqdn\": \"10.192.201.163\",\n \"username\": \"admin\",\n \"password\": \"Admin!23Admin\",\n \"thumbprint\": \"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\"\n }],\n \"maximum_rtt\": 250,\n \"fail_if_rtt_exceeded\": true,\n \"fail_if_rtep_misconfigured\": true\n \"display_name\": \"Paris, EU Site\",\n \"description\" : \"Site managing call center workloads in western Europe\",\n \"_revision\" : 1\n}\n",
"x-vmw-nsx-module": "PolicySiteGM",
"x-vmw-nsx-example-response": "{\n \"resource_type\": \"Site\",\n \"id\": \"Paris\",\n \"display_name\": \"Paris, EU Site\",\n \"description\" : \"Site managing call center workloads in western Europe\",\n \"path\": \"/infra/sites/Paris\",\n \"parent_path\": \"/infra/sites/Paris\",\n \"relative_path\": \"Paris\",\n \"site_connection_info\": [{\n \"fqdn\": \"10.192.201.163\"\n }],\n \"maximum_rtt\": 250,\n \"fail_if_rtt_exceeded\": true,\n \"fail_if_rtep_misconfigured\": true\n \"_create_user\": \"admin\",\n \"_create_time\": 1517262573524,\n \"_last_modified_user\": \"admin\",\n \"_last_modified_time\": 1517262573524,\n \"_system_owned\": false,\n \"_protection\": \"NOT_PROTECTED\",\n \"_revision\": 2\n}\n",
"x-codegen-request-body-name": "Site"
},
"delete": {
"tags": [
"Federation",
"Sites"
],
"summary": "Delete a site",
"description": "Delete a site under Infra.\n",
"operationId": "DeleteInfraSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "DELETE https://<policy-mgr>/policy/api/v1/infra/sites/Paris\n",
"x-vmw-nsx-module": "PolicySiteGM"
},
"patch": {
"tags": [
"Federation",
"Sites"
],
"summary": "Create or patch Site",
"description": "Create or patch Site under Infra.\n",
"operationId": "PatchInfraSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
},
"x-vmw-nsx-example-request": "PATCH https://<policy-mgr>/policy/api/v1/infra/sites/Paris\n{\n \"site_connection_info\": [{\n \"fqdn\": \"10.192.201.163\",\n \"username\": \"admin\",\n \"password\": \"Admin!23Admin\",\n \"thumbprint\": \"f53d7052535613b3032a41d555631228cb4d0d8b584a8225b94fbf0ba83eb9a4\"\n }],\n \"maximum_rtt\": 250,\n \"fail_if_rtt_exceeded\": true,\n \"fail_if_rtep_misconfigured\": true\n \"display_name\": \"Paris, EU Site\",\n \"description\" : \"Site managing call center workloads in western Europe\",\n}\n",
"x-vmw-nsx-module": "PolicySiteGM",
"x-codegen-request-body-name": "Site"
}
},
"/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?action=delete_dhcp_leases": {
"post": {
"tags": [
"Policy",
"Networking",
"IP Management",
"DHCP",
"DHCP Leases"
],
"summary": "Delete DHCP lease(s) specified by IP and MAC",
"description": "Delete one or multiple DHCP lease(s) specified by IP and MAC.\n\nIf there is a DHCP server running upon the given segment, or this segment\nis using a DHCP server running in its connected Tier-0 or Tier-1, the DHCP\nlease(s) which match exactly the IP address and the MAC address will be\ndeleted. If no such lease matches, the deletion for this lease will be\nignored.\n\nThe DHCP lease to be deleted will be removed by the system from both active\nand standby node. The system will report error if the DHCP lease could not\nbe removed from both nodes. If the DHCP lease could not be removed on either\nnode, please check the DHCP server status. Once the DHCP server status is\nUP, please invoke the deletion API again to ensure the lease gets deleted\nfrom both nodes.\n",
"operationId": "OrgsOrgIdProjectsProjectIdInfraDeleteDhcpLease",
"parameters": [
{
"name": "org-id",
"in": "path",
"description": "The organization ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project-id",
"in": "path",
"description": "The project ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "segment-id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enforcement_point_path",
"in": "query",
"description": "Enforcement point path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DhcpDeleteLeases"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"412": {
"description": "Precondition Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref":